TouchInstinct
/
checkstyle
306
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add Organize Imports instructions to site. #1448

This commit is contained in:
Aleksandr Ivanov 2015-07-24 19:17:16 +03:00 committed by Roman Ivanov
parent 01ef15b55d
commit 89d3ad0802
6 changed files with 61 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
src/site/resources/images/gui_screenshot_organize_imports_eclipse.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 63 KiB

BIN
src/site/resources/images/gui_screenshot_organize_imports_idea.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 109 KiB

BIN
src/site/resources/images/gui_screenshot_organize_imports_netbeans.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 111 KiB

21
src/xdocs/eclipse.xml
View File

@ -19,6 +19,13 @@
</head>
<body>
<section name="Content">
<macro name="toc">
<param name="fromDepth" value="1"/>
<param name="toDepth" value="1"/>
</macro>
</section>
<section name="Import Checkstyle Project">
<p>
Select File > Import > Maven > Existing Maven Projects<br/><br/>
@ -43,5 +50,19 @@
and F8 (Resume)
</p>
</section>
<section name="Organize Imports">
<p>
One of the Checkstyle checks we run on our own code require sertain order of import
statements. Few changes in IDE settings are required to help your IDE do it automatically.<br/>
To change settings of "Organize Imports" feature (Kepler, Luna &amp; Mars, other versions
are likely to work the same way), please go to Window -> Preferences in menu.<br/>
In Preferences window select Java->Code Style->Organize Imports (follow numbers on a picture).<br/>
Default configuration should look as following (you can also try Restore Defaults button):<br/><br/>
<img alt="Organize Imports settings in Eclipse" src="images/gui_screenshot_organize_imports_eclipse.jpg"/>
<br/><br/>
</p>
</section>
</body>
</document>

20
src/xdocs/idea.xml
View File

@ -19,6 +19,13 @@
</head>
<body>
<section name="Content">
<macro name="toc">
<param name="fromDepth" value="1"/>
<param name="toDepth" value="1"/>
</macro>
</section>
<section name="Import Checkstyle Project">
<p>
If no project is currently open in IntelliJ IDEA, click Import Project on the
@ -48,5 +55,18 @@
F7 (Step Into), Alt+F9 (Run to Cursor)
</p>
</section>
<section name="Organize Imports">
<p>
One of the Checkstyle checks we run on our own code require sertain order of import
statements. Few changes in IDE settings are required to help your IDE do it automatically.<br/>
To change formatter settings please go to File->Settings in menu.<br/>
Then in the tree go to: Editor->Code Style->Java, open Import tab (follow numbers on a
picture) and apply settings highlighted:<br/><br/>
<img alt="Organize Imports settings in IDEA" src="images/gui_screenshot_organize_imports_idea.jpg"/>
<br/><br/>
</p>
</section>
</body>
</document>

20
src/xdocs/netbeans.xml
View File

@ -19,6 +19,13 @@
</head>
<body>
<section name="Content">
<macro name="toc">
<param name="fromDepth" value="1"/>
<param name="toDepth" value="1"/>
</macro>
</section>
<section name="Import Checkstyle Project">
<p>
Select File > New Project > Maven > Project with existing POM<br/><br/>
@ -45,5 +52,18 @@
Shift+F8 (Step Over Expression), Step Over (F8)
</p>
</section>
<section name="Organize Imports">
<p>
One of the Checkstyle checks we run on our own code require sertain order of import
statements. Few changes in IDE settings are required to help your IDE do it automatically.<br/>
To change formatter settings please go to Tools->Options in menu.<br/>
On Options page go to Editor->Formatting->Java->Imports (follow numbers on a
picture) and apply settings highlighted:<br/><br/>
<img alt="Organize Imports settings in NetBeans" src="images/gui_screenshot_organize_imports_netbeans.jpg"/>
<br/><br/>
</p>
</section>
</body>
</document>