diff --git a/pom.xml b/pom.xml index 28ef03b92..8075540eb 100755 --- a/pom.xml +++ b/pom.xml @@ -392,6 +392,11 @@ + + + org.apache.maven.plugins + maven-linkcheck-plugin + @@ -412,6 +417,16 @@ + diff --git a/src/xdocs/anttask.xml.vm b/src/xdocs/anttask.xml.vm index 1629179fa..251b9ad5b 100755 --- a/src/xdocs/anttask.xml.vm +++ b/src/xdocs/anttask.xml.vm @@ -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 http://ant.apache.org/manual/CoreTypes/antlib.html + href="http://ant.apache.org/manual/Types/antlib.html" + >http://ant.apache.org/manual/Types/antlib.html for more details). For example:

@@ -233,7 +233,7 @@

This task supports the nested elements <fileset>, + href="http://ant.apache.org/manual/Types/fileset.html"><fileset>, <classpath>, <formatter>, and AvoidStarImport, ConstantName, and EmptyBlock. (Modules AvoidStarImport, ConstantName, and Filter SuppressionFilter rejects audit events for Check errors according to - a suppressions XML + a suppressions XML document in a file. If there is no configured suppressions file, the Filter accepts all audit events.

@@ -699,7 +699,7 @@

- A suppressions XML + A suppressions XML document contains a set of suppress elements, where each suppress element can have the @@ -1132,7 +1132,7 @@ custom listener, add a Checker submodule for the listener and its properties. For example, to configure a Checker so that it uses custom listener VerboseListener to + href="writinglisteners.html#Writing_Listeners">VerboseListener to print audit messages to a file named "audit.txt", include the following module in the configuration file:

diff --git a/src/xdocs/config_annotation.xml b/src/xdocs/config_annotation.xml index 4566effb8..9ebcd010e 100644 --- a/src/xdocs/config_annotation.xml +++ b/src/xdocs/config_annotation.xml @@ -92,7 +92,7 @@ -

TreeWalker

+

TreeWalker

@@ -114,7 +114,7 @@ -

TreeWalker

+

TreeWalker

@@ -173,7 +173,7 @@ -

TreeWalker

+

TreeWalker

@@ -208,7 +208,7 @@ -

TreeWalker

+

TreeWalker

@@ -334,7 +334,7 @@ -

TreeWalker

+

TreeWalker

diff --git a/src/xdocs/config_blocks.xml b/src/xdocs/config_blocks.xml index e093dfa57..87fadcb95 100755 --- a/src/xdocs/config_blocks.xml +++ b/src/xdocs/config_blocks.xml @@ -85,7 +85,7 @@ -

TreeWalker

+

TreeWalker

@@ -183,7 +183,7 @@ -

TreeWalker

+

TreeWalker

@@ -242,7 +242,7 @@ -

TreeWalker

+

TreeWalker

@@ -332,7 +332,7 @@ -

TreeWalker

+

TreeWalker

@@ -432,7 +432,7 @@ switch (a) -

TreeWalker

+

TreeWalker

diff --git a/src/xdocs/config_coding.xml b/src/xdocs/config_coding.xml index e235d7ebc..ca61154b8 100755 --- a/src/xdocs/config_coding.xml +++ b/src/xdocs/config_coding.xml @@ -55,7 +55,7 @@ return new int[] { 0 };

- TreeWalker + TreeWalker

@@ -93,7 +93,7 @@ String b = (a==null || a.length<1) ? null : a.substring(1);

- TreeWalker + TreeWalker

@@ -132,7 +132,7 @@ String b = (a==null || a.length<1) ? null : a.substring(1);

- TreeWalker + TreeWalker

@@ -197,7 +197,7 @@ public class MySingleton

- TreeWalker + TreeWalker

@@ -226,7 +226,7 @@ public class MySingleton

- TreeWalker + TreeWalker

@@ -315,7 +315,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -354,7 +354,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -427,7 +427,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -558,7 +558,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -634,7 +634,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -699,7 +699,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -743,7 +743,7 @@ number.equals(i + j); message Message which is used to notify about violations; if empty then the default message is used. - String + String ""(empty) @@ -782,7 +782,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -869,7 +869,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -934,7 +934,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -972,7 +972,7 @@ number.equals(i + j);

- TreeWalker + TreeWalker

@@ -1014,7 +1014,7 @@ for (int i = 0; i < 1; i++) {

- TreeWalker + TreeWalker

@@ -1112,7 +1112,7 @@ for (int i = 0; i < 1; i++) {

- TreeWalker + TreeWalker

@@ -1149,7 +1149,7 @@ for (int i = 0; i < 1; i++) {

- TreeWalker + TreeWalker

@@ -1197,7 +1197,7 @@ return !valid();

- TreeWalker + TreeWalker

@@ -1239,7 +1239,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1294,7 +1294,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1349,7 +1349,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1481,7 +1481,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1511,7 +1511,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1546,7 +1546,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1582,7 +1582,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1636,7 +1636,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1687,7 +1687,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1721,7 +1721,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1762,7 +1762,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1835,7 +1835,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -1933,7 +1933,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -2010,7 +2010,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -2043,7 +2043,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -2087,7 +2087,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -2125,7 +2125,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -2155,7 +2155,7 @@ if ("something".equals(x))

- TreeWalker + TreeWalker

@@ -2258,7 +2258,7 @@ case 3:

- TreeWalker + TreeWalker

@@ -2368,7 +2368,7 @@ case 3:

- TreeWalker + TreeWalker

@@ -2405,7 +2405,7 @@ case 3:

- TreeWalker + TreeWalker

@@ -2469,7 +2469,7 @@ case 3:

- TreeWalker + TreeWalker

@@ -2498,7 +2498,7 @@ case 3:

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_design.xml b/src/xdocs/config_design.xml index 9081dde52..559d504d2 100755 --- a/src/xdocs/config_design.xml +++ b/src/xdocs/config_design.xml @@ -99,7 +99,7 @@

- TreeWalker + TreeWalker

@@ -129,7 +129,7 @@

- TreeWalker + TreeWalker

@@ -193,7 +193,7 @@

- TreeWalker + TreeWalker

@@ -249,7 +249,7 @@ public class StringUtils // not final to allow subclassing

- TreeWalker + TreeWalker

@@ -305,7 +305,7 @@ public class StringUtils // not final to allow subclassing

- TreeWalker + TreeWalker

@@ -370,7 +370,7 @@ public class StringUtils // not final to allow subclassing

- TreeWalker + TreeWalker

@@ -429,7 +429,7 @@ public class StringUtils // not final to allow subclassing

- TreeWalker + TreeWalker

@@ -459,7 +459,7 @@ public class StringUtils // not final to allow subclassing

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_duplicates.xml b/src/xdocs/config_duplicates.xml index 86d5c4a7f..2966ee933 100755 --- a/src/xdocs/config_duplicates.xml +++ b/src/xdocs/config_duplicates.xml @@ -103,7 +103,7 @@ alternative to the Checks we offer in our distribution. min how many lines must be equal to be considered a duplicate - int + int 12 diff --git a/src/xdocs/config_imports.xml b/src/xdocs/config_imports.xml index f0a0d5979..db710b1e1 100755 --- a/src/xdocs/config_imports.xml +++ b/src/xdocs/config_imports.xml @@ -63,7 +63,7 @@

- TreeWalker + TreeWalker

@@ -137,7 +137,7 @@

- TreeWalker + TreeWalker

@@ -200,7 +200,7 @@

- TreeWalker + TreeWalker

@@ -245,7 +245,7 @@

- TreeWalker + TreeWalker

@@ -317,7 +317,7 @@ class FooBar {

- TreeWalker + TreeWalker

@@ -369,7 +369,7 @@ class FooBar { ordered whether imports within group should be sorted - Boolean + Boolean true @@ -378,13 +378,13 @@ class FooBar { whether imports groups should be separated by, at least, one blank line - Boolean + Boolean false caseSensitive whether string comparision should be case sensitive or not - Boolean + Boolean true @@ -417,7 +417,7 @@ class FooBar {

- TreeWalker + TreeWalker

@@ -517,7 +517,7 @@ class FooBar {

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml index b3ce1595e..c04d4f67f 100755 --- a/src/xdocs/config_javadoc.xml +++ b/src/xdocs/config_javadoc.xml @@ -207,7 +207,7 @@

- TreeWalker + TreeWalker

@@ -465,7 +465,7 @@ public boolean isSomething()

- TreeWalker + TreeWalker

@@ -541,7 +541,7 @@ public boolean isSomething()

- TreeWalker + TreeWalker

@@ -736,7 +736,7 @@ public boolean isSomething()

- TreeWalker + TreeWalker

@@ -818,7 +818,7 @@ public boolean isSomething()

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_metrics.xml b/src/xdocs/config_metrics.xml index 6b347ddd0..8e3a493f4 100755 --- a/src/xdocs/config_metrics.xml +++ b/src/xdocs/config_metrics.xml @@ -111,7 +111,7 @@

- TreeWalker + TreeWalker

@@ -174,7 +174,7 @@

- TreeWalker + TreeWalker

@@ -232,7 +232,7 @@

- TreeWalker + TreeWalker

@@ -300,7 +300,7 @@

- TreeWalker + TreeWalker

@@ -365,7 +365,7 @@

- TreeWalker + TreeWalker

@@ -463,7 +463,7 @@

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_misc.xml b/src/xdocs/config_misc.xml index 0f367b8f5..56aacdb28 100755 --- a/src/xdocs/config_misc.xml +++ b/src/xdocs/config_misc.xml @@ -156,7 +156,7 @@

- TreeWalker + TreeWalker

@@ -164,7 +164,7 @@

- A FileSetCheck that ensures + A FileSetCheck 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.

- TreeWalker + TreeWalker

@@ -341,7 +341,7 @@ messages.properties: Key 'ok' missing.

- TreeWalker + TreeWalker

@@ -400,7 +400,7 @@ messages.properties: Key 'ok' missing.

- TreeWalker + TreeWalker

@@ -478,7 +478,7 @@ messages.properties: Key 'ok' missing.

- TreeWalker + TreeWalker

@@ -557,13 +557,13 @@ messages.properties: Key 'ok' missing. minimumMessage error message when minimum count not reached - String + String "descendant.token.min" maximumMessage error message when maximum count exceeded - String + String "descendant.token.max" @@ -760,7 +760,7 @@ messages.properties: Key 'ok' missing.

- TreeWalker + TreeWalker

@@ -838,7 +838,7 @@ messages.properties: Key 'ok' missing.

- TreeWalker + TreeWalker

@@ -958,7 +958,7 @@ d = e / f; // Another comment for this line

- TreeWalker + TreeWalker

@@ -1031,7 +1031,7 @@ d = e / f; // Another comment for this line message message which is used to notify about violations, if empty then default(hard-coded) message is used. - String + String ""(empty) @@ -1398,7 +1398,7 @@ public class PID extends StateMachine implements WebObject.Constants {

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_modifier.xml b/src/xdocs/config_modifier.xml index b82b130a5..48df1ce21 100755 --- a/src/xdocs/config_modifier.xml +++ b/src/xdocs/config_modifier.xml @@ -70,7 +70,7 @@

- TreeWalker + TreeWalker

@@ -161,7 +161,7 @@

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_naming.xml b/src/xdocs/config_naming.xml index aef02952e..b96dd2ecd 100755 --- a/src/xdocs/config_naming.xml +++ b/src/xdocs/config_naming.xml @@ -34,7 +34,7 @@

All naming modules belong to package com.puppycrawl.tools.checkstyle.checks.naming and - are submodules of TreeWalker.

diff --git a/src/xdocs/config_regexp.xml b/src/xdocs/config_regexp.xml index f587c6f22..214a38414 100644 --- a/src/xdocs/config_regexp.xml +++ b/src/xdocs/config_regexp.xml @@ -44,7 +44,7 @@ message message which is used to notify about violations, if empty then default(hard-coded) message is used. - String + String ""(empty) @@ -122,7 +122,7 @@

- Checker + Checker

@@ -159,7 +159,7 @@ message message which is used to notify about violations, if empty then default(hard-coded) message is used. - String + String ""(empty) @@ -209,7 +209,7 @@

- Checker + Checker

@@ -243,7 +243,7 @@ message message which is used to notify about violations, if empty then default(hard-coded) message is used. - String + String ""(empty) @@ -307,7 +307,7 @@

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_sizes.xml b/src/xdocs/config_sizes.xml index f98a0be25..b6d1f3143 100755 --- a/src/xdocs/config_sizes.xml +++ b/src/xdocs/config_sizes.xml @@ -78,7 +78,7 @@

- TreeWalker + TreeWalker

@@ -208,7 +208,7 @@ number of expanded spaces for a tab character ('\t'). The default number of spaces is 8. To specify a different number of spaces, - the user can set TreeWalker property tabWidth which applies to all Checks, including LineLength; or can set @@ -232,7 +232,7 @@

- TreeWalker + TreeWalker

@@ -334,7 +334,7 @@

- TreeWalker + TreeWalker

@@ -390,7 +390,7 @@

- TreeWalker + TreeWalker

@@ -464,7 +464,7 @@

- TreeWalker + TreeWalker

@@ -526,7 +526,7 @@

- TreeWalker + TreeWalker

diff --git a/src/xdocs/config_whitespace.xml b/src/xdocs/config_whitespace.xml index b4e3a1654..7c6b92d82 100755 --- a/src/xdocs/config_whitespace.xml +++ b/src/xdocs/config_whitespace.xml @@ -60,7 +60,7 @@ List < List < Integer > > y = new ArrayList < List < Integer &

- TreeWalker + TreeWalker

@@ -124,7 +124,7 @@ for (

- TreeWalker + TreeWalker

@@ -188,7 +188,7 @@ for (Iterator foo = very.long.line.iterator();

- TreeWalker + TreeWalker

@@ -297,7 +297,7 @@ for (Iterator foo = very.long.line.iterator();

- TreeWalker + TreeWalker

@@ -404,7 +404,7 @@ for (Iterator foo = very.long.line.iterator();

- TreeWalker + TreeWalker

@@ -491,7 +491,7 @@ for (Iterator foo = very.long.line.iterator();

- TreeWalker + TreeWalker

@@ -673,7 +673,7 @@ for (Iterator foo = very.long.line.iterator();

- TreeWalker + TreeWalker

@@ -763,7 +763,7 @@ for (Iterator foo = very.long.line.iterator();

- TreeWalker + TreeWalker

@@ -839,7 +839,7 @@ for (Iterator foo = very.long.line.iterator();

- TreeWalker + TreeWalker

@@ -990,7 +990,7 @@ for (Iterator foo = very.long.line.iterator();

- TreeWalker + TreeWalker

@@ -1166,7 +1166,7 @@ public void func() {} // empty method

- TreeWalker + TreeWalker

diff --git a/src/xdocs/index.xml.vm b/src/xdocs/index.xml.vm index 46943e502..2bd2940e5 100644 --- a/src/xdocs/index.xml.vm +++ b/src/xdocs/index.xml.vm @@ -81,11 +81,7 @@

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 available, but - we strongly encourage plugin authors to upgrade. The known plug-ins - are: + many improvements since then. The known plug-ins are:

diff --git a/src/xdocs/running.xml b/src/xdocs/running.xml index d5b57536c..901888650 100755 --- a/src/xdocs/running.xml +++ b/src/xdocs/running.xml @@ -22,7 +22,7 @@

- Note that there are loads of + Note that there are loads of plug-ins for all the IDE's out there.

diff --git a/src/xdocs/writingfilters.xml b/src/xdocs/writingfilters.xml index 5a83206b7..0b5adc76d 100755 --- a/src/xdocs/writingfilters.xml +++ b/src/xdocs/writingfilters.xml @@ -106,7 +106,7 @@ public class FilesFilter To incorporate a Filter in the filter set for a Checker, include a module element for the Filter in the configuration file. For example, to + href="config.html#Filters">configuration file. For example, to configure a Checker so that it uses custom filter FilesFilter to prevent reporting of audit events for files whose name contains "Generated", diff --git a/src/xdocs/writinglisteners.xml.vm b/src/xdocs/writinglisteners.xml.vm index 449f31987..b612ec2db 100755 --- a/src/xdocs/writinglisteners.xml.vm +++ b/src/xdocs/writinglisteners.xml.vm @@ -201,7 +201,7 @@ public class VerboseListener To incorporate a custom listener in the set of listeners for a Checker, include a module element for the listener in the configuration file. For + href="config.html#AuditListeners">configuration file. For example, to configure a Checker so that it uses custom listener VerboseListener to print audit messages to a @@ -239,21 +239,22 @@ Audit finished. Total errors: 1 href="http://ant.apache.org/">ANT listeners. The first listener, CommonsLoggingListener, hands off events to the Jakarata + href="http://commons.apache.org/logging/">Jakarata Commons Logging facade and the second, MailLogger, sends a report of an audit via e-mail. The discussion of these examples and how to use them is derived from material in "Java Development + href="http://www.manning.com/hatcher/">"Java Development with Ant" by Eric Hatcher and Steve Loughran, an excellent ANT book.

+

CommonsLoggingListener

Jakarata + href="http://commons.apache.org/logging/">Jakarata Commons Logging provides a facade for logging tools log4j, @@ -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 Jdk14Logger. + href="http://commons.apache.org/logging/apidocs/org/apache/commons/logging/impl/Jdk14Logger.html">Jdk14Logger. Under earlier Java versions, the default Log is a simple wrapper class, SimpleLog. + href="http://commons.apache.org/logging/apidocs/org/apache/commons/logging/impl/SimpleLog.html">SimpleLog. 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

Logging configuration details for Jakarta Commons Logging are in the documentation. + href="http://commons.apache.org/logging/">documentation. As a simple example, assume that log4j.jar is in the classpath and the following log4j.properties file is @@ -332,6 +333,7 @@ INFO com.puppycrawl...Checker - File "VerboseListener.java" finished. INFO com.puppycrawl...Checker - Audit finished. +

MailLogger

MailLogger sends an audit report in an