Skip to content

Commit 29fa467

Browse files
authored
Merge pull request #322 from domaframework/docs
Describe settings for IntelliJ IDEA Community Edition 2019.2.1
2 parents 858871e + abecacf commit 29fa467

File tree

6 files changed

+16
-42
lines changed

6 files changed

+16
-42
lines changed

docs/getting-started-idea.rst

Lines changed: 16 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Get started!(IntelliJ IDEA)
88
Summary
99
========
1010

11-
Introduce how to setting up development environment and how to executing basic database access.
11+
We introduce how to set up development environment and how to execute basic database access.
1212

1313
Install JDK
1414
==================
1515

1616
.. _JDK 8: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
1717

18-
You install `JDK 8`_ .
18+
Install `JDK 8`_ .
1919

2020
.. note::
2121

@@ -27,86 +27,60 @@ Install IntelliJ IDEA
2727

2828
.. _IntelliJ IDEA Community Edition: https://www.jetbrains.com/idea/download/
2929

30-
You install `IntelliJ IDEA Community Edition`_ .
30+
Install `IntelliJ IDEA Community Edition`_ .
3131

3232
.. _IntelliJ Doma support plugin: https://plugins.jetbrains.com/plugin/7615-doma-support
3333

3434
.. note::
3535

36-
In this document, using IntelliJ IDEA Community Edition as IDE.
36+
In this document, we use IntelliJ IDEA Community Edition 2019.2.1 as IDE.
3737
If you use IntelliJ IDEA Ultimate Edition, recommend to you concomitant use with `IntelliJ Doma support plugin`_.
3838

3939
Import template project
4040
============================
4141

42-
You clone simple-boilerplate from GitHub.
42+
Clone simple-boilerplate from GitHub:
4343

4444
.. code-block:: bash
4545
4646
$ git clone https://github.com/domaframework/simple-boilerplate.git
4747
48-
You start IntelliJ IDEA and execute Import Project, select the cloned simple-boilerplate.
48+
Start IntelliJ IDEA and execute Import Project, and select the cloned simple-boilerplate:
4949

5050
.. image:: images/idea-welcome.png
5151
:width: 60 %
5252

5353
|
5454
55-
You check Import project from external model and select Gradle.
55+
Check Import project from external model and select Gradle:
5656

5757
.. image:: images/idea-import-project.png
5858
:width: 100 %
5959

60-
|
61-
62-
You check Use auto-import and uncheck Create separate module per source set.
63-
Finally you push Finish.
64-
65-
.. image:: images/idea-import-project-settings.png
66-
:width: 100 %
67-
68-
|
69-
60+
Push the Finish button.
7061
If the message that is synced successfully is shown at Build tool window then import is success.
7162

7263
.. _idea-annotation-processor:
7364

7465
Setting of Annotation Processor
7566
================================
7667

77-
You select Open Module Settings from context menu on tool window.
78-
79-
.. image:: images/idea-open-module-settings.png
80-
:width: 100 %
81-
82-
|
83-
84-
You open setting screen of Paths of Modules and confirm that Inherit project compile output path is selected.
85-
If it is not selected, you select it.
86-
87-
.. image:: images/idea-output-path.png
88-
:width: 100 %
89-
90-
|
91-
92-
You open Build, Execution, Deployment > Compiler > Annotation Processors from Preferences.
93-
You check Enable annotation processing.
94-
You check Module content root.
95-
You input gen/production to Production sources directory and input gen/test to Test sources directory.
96-
Finally push OK.
68+
Open Build, Execution, Deployment > Compiler > Annotation Processors from Preferences.
69+
Check Enable annotation processing:
9770

9871
.. image:: images/idea-annotation-processors.png
9972
:width: 100 %
10073

101-
|
74+
Setting of Build and Run
75+
================================
10276

103-
You execute Build Project from menu.
104-
By build, the code that is generated by Annotation Processor is output to gen/production.
105-
You select Mark Directory as | Generated Sources Root from context menu on Project tool window and add gen/production to source path.
77+
Open Build, Execution, Deployment > Build Tools > Gradle from Preferences.
78+
Choose IntelliJ IDEA for Run tests using:
10679

107-
.. image:: images/idea-generated-sources-root.png
80+
.. image:: images/run-tests-using.png
10881
:width: 100 %
10982

83+
Try to build and run test cases.
11084

11185
Structure of template project
11286
==============================

docs/images/idea-annotation-processors.png

100755100644
-291 KB
Loading
-176 KB
Binary file not shown.

docs/images/idea-import-project.png

100755100644
-2.63 KB
Loading

docs/images/idea-welcome.png

17.4 KB
Loading

docs/images/run-tests-using.png

250 KB
Loading

0 commit comments

Comments
 (0)