From 78ab632ff2bcf9677a2c7e70a432ca4ae91bb7b8 Mon Sep 17 00:00:00 2001 From: Oliver Burn Date: Fri, 2 Nov 2001 05:58:51 +0000 Subject: [PATCH] updated docs --- docs/anttask.html | 17 +++++++++++++++++ docs/cmdline.html | 12 ++++++++++++ 2 files changed, 29 insertions(+) diff --git a/docs/anttask.html b/docs/anttask.html index 55c5b7f3a..aec111c01 100644 --- a/docs/anttask.html +++ b/docs/anttask.html @@ -62,6 +62,13 @@ This task is included in the checkstyle distribution.

Specifies the maximum line length. Default value is defined here. No + + ignoreImportLen + Specifies whether to ignore the maximum line length for import statements. Defaults to "false". + No + + + memberPattern Specifies the regular expression to match against member variables. Default value is defined here. @@ -107,6 +114,11 @@ This task is included in the checkstyle distribution.

Specifies whether to relax checking Javadoc comments. Defaults to "false". No + + ignoreJavadoc + Specifies whether to completely ignore checking Javadoc comments. Defaults to "false". + No + ignoreImports Specifies whether to ignore checking import statements. Defaults to "false". @@ -127,6 +139,11 @@ This task is included in the checkstyle distribution.

Specifies whether the build will continue even if there are violations. Defaults to "true". No + + cacheFile + Specifies the name of a file that can be used to cache details of files that pass checkstyle. This can signicantly increase the speed of checkstyle on successive runs. + No +

Examples

diff --git a/docs/cmdline.html b/docs/cmdline.html index 02957a956..50847bf03 100644 --- a/docs/cmdline.html +++ b/docs/cmdline.html @@ -55,6 +55,10 @@ This command line tool is included in the checkstyle distribution.

checkstyle.maxlinelen Specifies the maximum line length. Default value is defined here. + + checkstyle.ignore.importlength + Specifies whether to ignore the maximum line length for import statements. Defaults to "false". + checkstyle.pattern.member Specifies the regular expression to match against member variables. Default value is defined here. @@ -91,6 +95,10 @@ This command line tool is included in the checkstyle distribution.

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.ignore.imports Specifies whether to ignore checking import statements. Defaults to "no". @@ -103,6 +111,10 @@ This command line tool is included in the checkstyle distribution.

checkstyle.ignore.braces Specifies whether to ignore checking braces. Defaults to "no". + + checkstyle.cache.file + Specifies the name of a file that can be used to cache details of files that pass checkstyle. This can signicantly increase the speed of checkstyle on successive runs. +

Examples