diff --git a/docs/anttask.html b/docs/anttask.html index 15e6e1b4d..01300d8cd 100644 --- a/docs/anttask.html +++ b/docs/anttask.html @@ -50,6 +50,12 @@ This task is included in the checkstyle distribution.

Indicates whether to allow protected data. Defaults to "false". No + + allowPackage + Indicates whether to allow package visible data. Defaults to "false". + No + + allowNoAuthor Indicates whether to allow no @author tag to be defined for class and interface Javadoc comments. Defaults to "false". @@ -112,6 +118,16 @@ This task is included in the checkstyle distribution.

Specifies the regular expression to match against type names. Default value is defined here. No + + methodPattern + Specifies the regular expression to match against method names. Default value is defined here. + No + + + localVarPattern + Specifies the regular expression to match against local variable names. Default value is defined here. + No + headerFile Specifies the file containing the header lines. Default is to not check. @@ -127,6 +143,11 @@ This task is included in the checkstyle distribution.

Specifies the visibility scope where javadoc comments are checked. Valid values are "nothing", "public", "protected", "package", "private" and "anoninner". Defaults to "private". No + + requirePackageHtml + Specifies whether to require that package documentation is available. Defaults to "false". + No + ignoreImports Specifies whether to ignore checking import statements. Defaults to "false". diff --git a/docs/cmdline.html b/docs/cmdline.html index 32ecc12d2..dccfb11c9 100644 --- a/docs/cmdline.html +++ b/docs/cmdline.html @@ -53,6 +53,10 @@ This command line tool is included in the checkstyle distribution.

checkstyle.allow.protected Indicates whether to allow protected data. Defaults to "no". + + + checkstyle.allow.package + Indicates whether to allow package visible data. Defaults to "no". checkstyle.allow.noauthor @@ -102,6 +106,14 @@ This command line tool is included in the checkstyle distribution.

checkstyle.pattern.type Specifies the regular expression to match against type names. Default value is defined here. + + checkstyle.pattern.method + Specifies the regular expression to match against method names. Default value is defined here. + + + checkstyle.pattern.localvar + Specifies the regular expression to match against local variable names. Default value is defined here. + checkstyle.header.file Specifies the file containing the header lines. Default is to not check. @@ -114,6 +126,11 @@ This command line tool is included in the checkstyle distribution.

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.require.packagehtml + Specifies whether to require that package documentation is available. Defaults to "false". + No + checkstyle.ignore.imports Specifies whether to ignore checking import statements. Defaults to "no". diff --git a/docs/engine.html b/docs/engine.html index 70ea10e08..5fc5bbd2b 100644 --- a/docs/engine.html +++ b/docs/engine.html @@ -53,6 +53,8 @@
  • method
    • +

    You can require that a package.html file exists for each package. This check is turned off by default.

    +

    Javadoc comments for class and interface declarations are checked to ensure that the @author tag exists. This can be turned off.

    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.

    @@ -164,10 +166,18 @@

    Verifies that the format of public member names conform to a specified regular expression. The default is ^f[A-Z][a-zA-Z0-9]*$. This is useful for the fields required for Container Managed Persistence (CMP) Enterprise JavaBeans 1.1.

    +

    Format of method names

    +

    Verifies that the format of method names conform to a specified regular expression. The default is ^[a-z][a-zA-Z0-9]*$.

    + + +

    Format of local variable names

    +

    Verifies that the format of local variables conform to a specified regular expression. The default is ^[a-z][a-zA-Z0-9]*$.

    + +

    Visibility Modifiers

    Checks for data members that are not declared private. Also finds static non-final data members that are not declared as private.

    -

    Note: you can turn on allowing protected data members.

    +

    Note: you can turn on allowing protected or package visible data members.

    Tip