This task runs checkstyle over specified Java files. The task has been tested using ANT 1.3. The latest version of checkstyle can be found at http://www.puppycrawl.com/checkstyle. +
This task runs checkstyle over specified Java files. The task has been tested using ANT 1.4.1. The latest version of checkstyle can be found at http://checkstyle.sourceforge.net/. This task is included in the checkstyle distribution.
The easiest way is to include checkstyle-all-1.3.jar in the classpath. This contains all the classes required to run checkstyle. Alternatively, you must include the following in the classpath:
+The easiest way is to include checkstyle-all-1.4.jar in the classpath. This contains all the classes required to run checkstyle. Alternatively, you must include the following in the classpath:
Older versions of the checkstyle task supported the boolean parameters relaxJavadoc and ignoreJavadoc. These parameters have been removed because they were conflicting and the semantics of relaxJavadoc was not clearly specified. The two parameters have been replaced by the javadocScope parameter. Instead of ignoreJavadoc="true" you can now use javadocScope="nothing". The behaviour of relaxJavadoc="true" is roughly the same as javadocScope="protected".
+Run checkstyle on a single file
diff --git a/docs/cmdline.html b/docs/cmdline.html
index 57f65210c..8ad62a485 100644
--- a/docs/cmdline.html
+++ b/docs/cmdline.html
@@ -104,12 +104,8 @@ This command line tool is included in the checkstyle distribution.
Specifies the line in the header to ignore when comparing. Default it to not ignore any line.
- checkstyle.javadoc.relax
- Specifies whether to relax checking Javadoc comments. Defaults to "no".
-
-
- checkstyle.javadoc.ignore
- Specifies whether to completely ignore checking Javadoc comments. Defaults to "no".
+ checkstyle.javadoc.scope
+ Specifies the visibility scope where javadoc comments are checked. Valid values are "nothing", "public", "protected", "package", "private" and "anoninner". Defaults to "private".
checkstyle.ignore.imports
@@ -129,6 +125,10 @@ This command line tool is included in the checkstyle distribution.
+
+Older versions of the checkstyle task supported the boolean parameters checkstyle.javadoc.relax and checkstyle.javadoc.ignore. These parameters have been removed because they were conflicting with each other and the semantics of relaxJavadoc was not specified. The two parameters have been replaced by the checkstyle.javadoc.scope parameter. Instead of checkstyle.javadoc.ignore=true you can now use checkstyle.javadoc.scope=nothing. The behaviour of checkstyle.javadoc.relax=true is roughly the same as checkstyle.javadoc.scope=protected.
+
+
Examples
Run checkstyle on a file
diff --git a/docs/index.html b/docs/index.html
index 7903b279a..2d68133df 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -54,7 +54,7 @@ div.tip {margin-left : 5%;margin-right : 5%;padding-left: 2%; padding-right: 2%;
Getting checkstyle
-Binary and source distributions are from http://checkstyle.sourceforge.net/.
+Binary and source distributions are available from http://checkstyle.sourceforge.net/.
Source code is stored under CVS at SourceForge. The project page is http://sourceforge.net/projects/checkstyle.
@@ -84,8 +84,13 @@ div.tip {margin-left : 5%;margin-right : 5%;padding-left: 2%; padding-right: 2%;
I have tested checkstyle using JRE1.2.2 and JRE1.3 on Windows 2000.
- +Checkstyle has been tested using +
Javadoc comments for class and interface declarations are checked to ensure that the @author tag exists. This can be turned off.
-You can make checkstyle relax the checking for Javadoc comments. When relaxed, checkstyle requires a Javadoc comment for public and protected variables and methods, and for interface and class definitions. You can also completely turn off all checking for Javadoc comments.
+You can control the visibility scope where Javadoc comments are checked. For example, you can check Javadoc code only for public and protected variables, methods, interfaces and class definitions. Scoping rules apply, in the above example a public method in a package visible class is not checked. You can also completely turn off all checking for Javadoc comments.
Javadoc comments for methods are checked to ensure that the following tags exist (if required):
If you have any feedback on this tool, please email me at checkstyle@puppycrawl.com. I am interested in any improvements you would like to see (or hopefully made!).
- -Also, send me email if you would like to be notified when a newer version of checkstyle is released.
+If you have general feedback (i.e. success stories ;-) on this tool, please send email to checkstyle@puppycrawl.com. Please use the SourceForge pages to report bugs or to submit feature requests. The developers of checkstyle are interested in any improvements you would like to see (or hopefully made!).
+ +Also, you can subscribe to the checkstyle-announce mailing list if you would like to be notified when a newer version of checkstyle is released.
Copyright © 2001 Oliver Burn. All rights Reserved.