checkstyle/src/xdocs/idea.xml

44 lines
1.7 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Importing and debugging in IntelliJ IDE</title>
<author>Checkstyle Development Team</author>
</properties>
<body>
<section name="Import Checkstyle Project">
<p>
If no project is currently open in IntelliJ IDEA, click Import Project on the
Welcome screen. Otherwise, select File > Import Project<br/><br/>
<img alt="screenshot" src="images/gui_screenshot_importing_idea.png"/>
<br/><br/>
<img alt="screenshot" src="images/gui_screenshot_importing_idea1.png"/>
<br/><br/>
Then Next > Next > ... Until Finish.
</p>
</section>
<section name="Debug">
<p>
Open the Check's source file by double click on it in a source tree as is shown:<br/><br/>
<img alt="screenshot" src="images/gui_screenshot_select_check_idea.png"/>
<br/><br/>
Debug the Check by putting the breakpoint at controversial place (double-click)
on the left part of line number as it is shown:<br/><br/>
<img alt="screenshot" src="images/gui_screenshot_debug_idea.png"/>
<br/><br/>
Then right-click the corresponding Unit-test file or class definition > Debug
&quot;testName&quot;<br/><br/>
<img alt="screenshot" src="images/gui_screenshot_ut_select_idea.png"/>
<br/><br/>
Then manage you debug operations F8 (Step Over), Shift+F8 (Step Out),
F7 (Step Into), Alt+F9 (Run to Cursor)
</p>
</section>
</body>
</document>