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

Used maven-linkcheck-plugin to identify broken links.

This commit is contained in:
Oliver Burn 2010-09-21 11:50:38 +00:00
parent 518a371c40
commit 5a643daa9c
21 changed files with 157 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
pom.xml
View File

@ -392,6 +392,11 @@
</instrumentation>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-linkcheck-plugin</artifactId>
</plugin>
</plugins>
</build>
@ -412,6 +417,16 @@
</reportSet>
</reportSets>
</plugin>
<!--
THE FOLLOWING DOES NOT WORK!
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-linkcheck-plugin</artifactId>
<configuration>
<excludedLinks><excludedLink>**/apidocs/**</excludedLink></excludedLinks>
</configuration>
</plugin>
-->
</plugins>
</reporting>

6
src/xdocs/anttask.xml.vm
View File

@ -86,8 +86,8 @@
Or if you use Ant 1.6 and later and assuming that Checkstyle
is in the library search path, then you may use antlib feature
of Ant (see <a
href="http://ant.apache.org/manual/CoreTypes/antlib.html"
>http://ant.apache.org/manual/CoreTypes/antlib.html</a>
href="http://ant.apache.org/manual/Types/antlib.html"
>http://ant.apache.org/manual/Types/antlib.html</a>
for more details). For example:
</p>
@ -233,7 +233,7 @@
<p>
This task supports the nested elements <a
href="http://ant.apache.org/manual/CoreTypes/fileset.html">&lt;fileset&gt;</a>,
href="http://ant.apache.org/manual/Types/fileset.html">&lt;fileset&gt;</a>,
<a
href="http://ant.apache.org/manual/using.html#path">&lt;classpath&gt;</a>,
<span class="default">&lt;formatter&gt;</span>, and <span

8
src/xdocs/config.xml
View File

@ -95,7 +95,7 @@
<span class="code">AvoidStarImport</span>, <span
class="code">ConstantName</span>, and <span
class="code">EmptyBlock</span>. (Modules <a
href="config_import.html"><span
href="config_imports.html"><span
class="code">AvoidStarImport</span></a>, <a
href="config_naming.html"><span
class="code">ConstantName</span></a>, and <a
@ -663,7 +663,7 @@
<p>
Filter <span class="code">SuppressionFilter</span> rejects
audit events for Check errors according to
a <a href="#XML%20Details"><em>suppressions XML
a <a href="#XML_Details"><em>suppressions XML
document</em></a> in a file. If there is no configured
suppressions file, the Filter accepts all audit events.
</p>
@ -699,7 +699,7 @@
</source>
<p>
A <a href="#XML%20Details"><em>suppressions XML
A <a href="#XML_Details"><em>suppressions XML
document</em></a> contains a set
of <span class="code">suppress</span> elements, where
each <span class="code">suppress</span> element can have the
@ -1132,7 +1132,7 @@
custom listener, add a <span>Checker</span> submodule for the
listener and its properties. For example, to configure a <span
class="code">Checker</span> so that it uses custom listener <a
href="writinglisteners.html#writing">VerboseListener</a> to
href="writinglisteners.html#Writing_Listeners">VerboseListener</a> to
print audit messages to a file named &quot;audit.txt&quot;,
include the following module in the configuration file:
</p>

10
src/xdocs/config_annotation.xml
View File

@ -92,7 +92,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
@ -114,7 +114,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
@ -173,7 +173,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
@ -208,7 +208,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
@ -334,7 +334,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
</body>

10
src/xdocs/config_blocks.xml
View File

@ -85,7 +85,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
@ -183,7 +183,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
@ -242,7 +242,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
@ -332,7 +332,7 @@
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
@ -432,7 +432,7 @@ switch (a)
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#treewalker">TreeWalker</a> </p>
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
</body>

86
src/xdocs/config_coding.xml
View File

@ -55,7 +55,7 @@ return new int[] { 0 };
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -93,7 +93,7 @@ String b = (a==null || a.length&lt;1) ? null : a.substring(1);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -132,7 +132,7 @@ String b = (a==null || a.length&lt;1) ? null : a.substring(1);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -197,7 +197,7 @@ public class MySingleton
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -226,7 +226,7 @@ public class MySingleton
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -315,7 +315,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -354,7 +354,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -427,7 +427,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -558,7 +558,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -634,7 +634,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -699,7 +699,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -743,7 +743,7 @@ number.equals(i + j);
<td>message</td>
<td>Message which is used to notify about violations;
if empty then the default message is used.</td>
<td><a href="property_types.html#String">String</a></td>
<td><a href="property_types.html#string">String</a></td>
<td><span class="default">&quot;&quot;</span>(empty)</td>
</tr>
</table>
@ -782,7 +782,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -869,7 +869,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -934,7 +934,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -972,7 +972,7 @@ number.equals(i + j);
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1014,7 +1014,7 @@ for (int i = 0; i &lt; 1; i++) {
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1112,7 +1112,7 @@ for (int i = 0; i &lt; 1; i++) {
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1149,7 +1149,7 @@ for (int i = 0; i &lt; 1; i++) {
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1197,7 +1197,7 @@ return !valid();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1239,7 +1239,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1294,7 +1294,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1349,7 +1349,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1481,7 +1481,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1511,7 +1511,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1546,7 +1546,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1582,7 +1582,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1636,7 +1636,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1687,7 +1687,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1721,7 +1721,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1762,7 +1762,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1835,7 +1835,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1933,7 +1933,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2010,7 +2010,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2043,7 +2043,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2087,7 +2087,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2125,7 +2125,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2155,7 +2155,7 @@ if (&quot;something&quot;.equals(x))
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2258,7 +2258,7 @@ case 3:
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2368,7 +2368,7 @@ case 3:
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2405,7 +2405,7 @@ case 3:
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2469,7 +2469,7 @@ case 3:
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -2498,7 +2498,7 @@ case 3:
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

16
src/xdocs/config_design.xml
View File

@ -99,7 +99,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -129,7 +129,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -193,7 +193,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -249,7 +249,7 @@ public class StringUtils // not final to allow subclassing
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -305,7 +305,7 @@ public class StringUtils // not final to allow subclassing
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -370,7 +370,7 @@ public class StringUtils // not final to allow subclassing
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -429,7 +429,7 @@ public class StringUtils // not final to allow subclassing
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -459,7 +459,7 @@ public class StringUtils // not final to allow subclassing
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

2
src/xdocs/config_duplicates.xml
View File

@ -103,7 +103,7 @@ alternative to the Checks we offer in our distribution.
<tr>
<td>min</td>
<td>how many lines must be equal to be considered a duplicate</td>
<td><a href="property_types.html#int">int</a></td>
<td><a href="property_types.html#integer">int</a></td>
<td><span class="default">12</span></td>
</tr>
<tr>

20
src/xdocs/config_imports.xml
View File

@ -63,7 +63,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -137,7 +137,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -200,7 +200,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -245,7 +245,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -317,7 +317,7 @@ class FooBar {
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -369,7 +369,7 @@ class FooBar {
<tr>
<td>ordered</td>
<td>whether imports within group should be sorted</td>
<td><a href="property_types.html#Boolean">Boolean</a></td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td>true</td>
</tr>
<tr>
@ -378,13 +378,13 @@ class FooBar {
whether imports groups should be separated by, at least, one
blank line
</td>
<td><a href="property_types.html#Boolean">Boolean</a></td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td>false</td>
</tr>
<tr>
<td>caseSensitive</td>
<td>whether string comparision should be case sensitive or not</td>
<td><a href="property_types.html#Boolean">Boolean</a></td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td>true</td>
</tr>
</table>
@ -417,7 +417,7 @@ class FooBar {
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -517,7 +517,7 @@ class FooBar {
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

10
src/xdocs/config_javadoc.xml
View File

@ -207,7 +207,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -465,7 +465,7 @@ public boolean isSomething()
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -541,7 +541,7 @@ public boolean isSomething()
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -736,7 +736,7 @@ public boolean isSomething()
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -818,7 +818,7 @@ public boolean isSomething()
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

12
src/xdocs/config_metrics.xml
View File

@ -111,7 +111,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -174,7 +174,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -232,7 +232,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -300,7 +300,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -365,7 +365,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -463,7 +463,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

26
src/xdocs/config_misc.xml
View File

@ -156,7 +156,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -164,7 +164,7 @@
<section name="Translation">
<subsection name="Description">
<p>
A <a href="config.html#overview">FileSetCheck</a> that ensures
A <a href="config.html#Overview">FileSetCheck</a> that ensures
the correct translation of code by checking property files for
consistency regarding their keys. Two property files
describing one and the same context are consistent if they
@ -303,7 +303,7 @@ messages.properties: Key 'ok' missing.
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -341,7 +341,7 @@ messages.properties: Key 'ok' missing.
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -400,7 +400,7 @@ messages.properties: Key 'ok' missing.
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -478,7 +478,7 @@ messages.properties: Key 'ok' missing.
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -557,13 +557,13 @@ messages.properties: Key 'ok' missing.
<tr>
<td>minimumMessage</td>
<td>error message when minimum count not reached</td>
<td><a href="property_types.html#String">String</a></td>
<td><a href="property_types.html#string">String</a></td>
<td>&quot;descendant.token.min&quot;</td>
</tr>
<tr>
<td>maximumMessage</td>
<td>error message when maximum count exceeded</td>
<td><a href="property_types.html#String">String</a></td>
<td><a href="property_types.html#string">String</a></td>
<td>&quot;descendant.token.max&quot;</td>
</tr>
</table>
@ -760,7 +760,7 @@ messages.properties: Key 'ok' missing.
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -838,7 +838,7 @@ messages.properties: Key 'ok' missing.
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -958,7 +958,7 @@ d = e / f; // Another comment for this line
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1031,7 +1031,7 @@ d = e / f; // Another comment for this line
<td>message</td>
<td>message which is used to notify about violations,
if empty then default(hard-coded) message is used.</td>
<td><a href="property_types.html#String">String</a></td>
<td><a href="property_types.html#string">String</a></td>
<td><span class="default">&quot;&quot;</span>(empty)</td>
</tr>
<tr>
@ -1398,7 +1398,7 @@ public class PID extends StateMachine implements WebObject.Constants {
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

4
src/xdocs/config_modifier.xml
View File

@ -70,7 +70,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -161,7 +161,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

2
src/xdocs/config_naming.xml
View File

@ -34,7 +34,7 @@
<p>
All naming modules belong to package <span
class="code">com.puppycrawl.tools.checkstyle.checks.naming</span> and
are submodules of <a href="config.html#treewalker"><span
are submodules of <a href="config.html#TreeWalker"><span
class="code">TreeWalker</span></a>.
</p>
</section>

12
src/xdocs/config_regexp.xml
View File

@ -44,7 +44,7 @@
<td>message</td>
<td>message which is used to notify about violations,
if empty then default(hard-coded) message is used.</td>
<td><a href="property_types.html#String">String</a></td>
<td><a href="property_types.html#string">String</a></td>
<td><span class="default">&quot;&quot;</span>(empty)</td>
</tr>
<tr>
@ -122,7 +122,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#checker">Checker</a>
<a href="config.html#Checker">Checker</a>
</p>
</subsection>
</section>
@ -159,7 +159,7 @@
<td>message</td>
<td>message which is used to notify about violations,
if empty then default(hard-coded) message is used.</td>
<td><a href="property_types.html#String">String</a></td>
<td><a href="property_types.html#string">String</a></td>
<td><span class="default">&quot;&quot;</span>(empty)</td>
</tr>
<tr>
@ -209,7 +209,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#checker">Checker</a>
<a href="config.html#Checker">Checker</a>
</p>
</subsection>
</section>
@ -243,7 +243,7 @@
<td>message</td>
<td>message which is used to notify about violations,
if empty then default(hard-coded) message is used.</td>
<td><a href="property_types.html#String">String</a></td>
<td><a href="property_types.html#string">String</a></td>
<td><span class="default">&quot;&quot;</span>(empty)</td>
</tr>
<tr>
@ -307,7 +307,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

14
src/xdocs/config_sizes.xml
View File

@ -78,7 +78,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -208,7 +208,7 @@
number of expanded spaces for a tab character (<span
class="code">'\t'</span>). The default number of spaces is <span
class="code">8</span>. To specify a different number of spaces,
the user can set <a href="config.html#treewalker"><span
the user can set <a href="config.html#TreeWalker"><span
class="code">TreeWalker</span></a> property <span
class="code">tabWidth</span> which applies to all Checks,
including <span class="code">LineLength</span>; or can set
@ -232,7 +232,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -334,7 +334,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -390,7 +390,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -464,7 +464,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -526,7 +526,7 @@
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

22
src/xdocs/config_whitespace.xml
View File

@ -60,7 +60,7 @@ List &lt; List &lt; Integer &gt; &gt; y = new ArrayList &lt; List &lt; Integer &
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -124,7 +124,7 @@ for (
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -188,7 +188,7 @@ for (Iterator foo = very.long.line.iterator();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -297,7 +297,7 @@ for (Iterator foo = very.long.line.iterator();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -404,7 +404,7 @@ for (Iterator foo = very.long.line.iterator();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -491,7 +491,7 @@ for (Iterator foo = very.long.line.iterator();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -673,7 +673,7 @@ for (Iterator foo = very.long.line.iterator();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -763,7 +763,7 @@ for (Iterator foo = very.long.line.iterator();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -839,7 +839,7 @@ for (Iterator foo = very.long.line.iterator();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -990,7 +990,7 @@ for (Iterator foo = very.long.line.iterator();
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
@ -1166,7 +1166,7 @@ public void func() {} // empty method</source>
<subsection name="Parent Module">
<p>
<a href="config.html#treewalker">TreeWalker</a>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>

6
src/xdocs/index.xml.vm
View File

@ -81,11 +81,7 @@
<p>
Additionally plug-ins are written by third-parties. Some of them are
still based on the Checkstyle 2.4 release, although there have been
many improvements since then. If you have to use such a plugin, the
documentation for Checkstyle 2.4 is still <a
href="http://checkstyle.sourceforge.net/old-2.4/">available</a>, but
we strongly encourage plugin authors to upgrade. The known plug-ins
are:
many improvements since then. The known plug-ins are:
</p>
<table>

2
src/xdocs/running.xml
View File

@ -22,7 +22,7 @@
</ul>
<p>
Note that there are <a href="index.html#Related Tools">loads of
Note that there are <a href="index.html#Related_Tools">loads of
plug-ins</a> for all the IDE's out there.
</p>
</section>

2
src/xdocs/writingfilters.xml
View File

@ -106,7 +106,7 @@ public class FilesFilter
To incorporate a <span class="code">Filter</span> in the filter set
for a <span class="code">Checker</span>, include a module element for
the <span class="code">Filter</span> in the <a
href="config.html#filters">configuration file</a>. For example, to
href="config.html#Filters">configuration file</a>. For example, to
configure a <span class="code">Checker</span> so that it uses custom
filter <span class="code">FilesFilter</span> to prevent reporting of
audit events for files whose name contains &quot;Generated&quot;,

16
src/xdocs/writinglisteners.xml.vm
View File

@ -201,7 +201,7 @@ public class VerboseListener
To incorporate a custom listener in the set of listeners for a
<span class="code">Checker</span>, include a module element for
the listener in the <a
href="config.html#auditlisteners">configuration file</a>. For
href="config.html#AuditListeners">configuration file</a>. For
example, to configure a <span class="code">Checker</span> so
that it uses custom listener <span
class="code">VerboseListener</span> to print audit messages to a
@ -239,21 +239,22 @@ Audit finished. Total errors: 1
href="http://ant.apache.org/">ANT</a> listeners. The first
listener, <span class="code"> CommonsLoggingListener</span>,
hands off events to the <a
href="http://jakarta.apache.org/commons/logging.html">Jakarata
href="http://commons.apache.org/logging/">Jakarata
Commons Logging</a> facade and the second, <span
class="code">MailLogger</span>, sends a report of an audit via
e-mail. The discussion of these examples and how to use them is
derived from material in <a
href="http://www.manning.com/antbook">&quot;Java Development
href="http://www.manning.com/hatcher/">&quot;Java Development
with Ant&quot;</a> by Eric Hatcher and Steve Loughran, an
excellent ANT book.
</p>
<a name="CommonsLoggingListener"/>
<h4>CommonsLoggingListener</h4>
<p>
<a
href="http://jakarta.apache.org/commons/logging.html">Jakarata
href="http://commons.apache.org/logging/">Jakarata
Commons Logging</a> provides a facade for logging tools
<a
href="http://jakarta.apache.org/log4j/docs/index.html">log4j</a>,
@ -283,10 +284,10 @@ Audit finished. Total errors: 1
in the classpath because that jar file contains all the Commons
Logging classes. The default Log under J2SE 1.4 is wrapper
class <a
href="http://jakarta.apache.org/commons/logging/api/org/apache/commons/logging/impl/Jdk14Logger.html">Jdk14Logger</a>.
href="http://commons.apache.org/logging/apidocs/org/apache/commons/logging/impl/Jdk14Logger.html">Jdk14Logger</a>.
Under earlier Java versions, the default Log is a simple wrapper
class, <a
href="http://jakarta.apache.org/commons/logging/api/org/apache/commons/logging/impl/SimpleLog.html">SimpleLog</a>.
href="http://commons.apache.org/logging/apidocs/org/apache/commons/logging/impl/SimpleLog.html">SimpleLog</a>.
Both default logging tools can be used directly from Commons
Logging; if you need to use other tools such as log4j, then you
must include the appropriate jar file(s) in the classpath.
@ -295,7 +296,7 @@ Audit finished. Total errors: 1
<p>
Logging configuration details for Jakarta Commons Logging are in
the <a
href="http://jakarta.apache.org/commons/logging.html">documentation</a>.
href="http://commons.apache.org/logging/">documentation</a>.
As a simple example, assume that <span
class="default">log4j.jar</span> is in the classpath and the
following <span class="default">log4j.properties</span> file is
@ -332,6 +333,7 @@ INFO com.puppycrawl...Checker - File "VerboseListener.java" finished.
INFO com.puppycrawl...Checker - Audit finished.
</source>
<a name="MailLogger"/>
<h4>MailLogger</h4>
<p>
<span class="code">MailLogger</span> sends an audit report in an