From a3d490b41f276fe42f8e028c26ea2e29f94c0aae Mon Sep 17 00:00:00 2001 From: Oliver Burn Date: Sun, 6 Jan 2002 06:29:19 +0000 Subject: [PATCH] Updated documentation for the new checks on method and constructor lengths --- docs/anttask.html | 10 ++++++++++ docs/cmdline.html | 8 ++++++++ docs/index.html | 7 +++++++ 3 files changed, 25 insertions(+) diff --git a/docs/anttask.html b/docs/anttask.html index 08e34cfd4..ac057a0dd 100644 --- a/docs/anttask.html +++ b/docs/anttask.html @@ -67,6 +67,16 @@ This task is included in the checkstyle distribution.

Specifies whether to ignore the maximum line length for import statements. Defaults to "false". No + + maxMethodLen + Specifies the maximum method length. Default value is defined here. + No + + + maxConstructorLen + Specifies the maximum constructor length. Default value is defined here. + No + diff --git a/docs/cmdline.html b/docs/cmdline.html index c1bc9e295..799ee5f8e 100644 --- a/docs/cmdline.html +++ b/docs/cmdline.html @@ -59,6 +59,14 @@ This command line tool is included in the checkstyle distribution.

checkstyle.ignore.importlength Specifies whether to ignore the maximum line length for import statements. Defaults to "false". + + checkstyle.maxmethodlen + Specifies the maximum method length. Default value is defined here. + + + checkstyle.maxconstructorlen + Specifies the maximum constructor length. Default value is defined here. + checkstyle.pattern.member Specifies the regular expression to match against member variables. Default value is defined here. diff --git a/docs/index.html b/docs/index.html index 58d73d3f1..1b380a404 100644 --- a/docs/index.html +++ b/docs/index.html @@ -38,6 +38,7 @@ div.tip {margin-left : 5%;margin-right : 5%;padding-left: 2%; padding-right: 2%;
  • Correct use of white space around binary and unary operators. For example, x -=- 1; is illegal, whereas x -= -1; is not. Note: these checks can be turned off.
  • Ensure {}'s are used for if/while/for/do constructs. Note: this check can be turned off.
  • Lines are not longer than a specified length.
    • +
  • Methods and constructors that are longer than a specified number of lines.
  • Lines do not contain tabs. Note: this check can be turned off.
    • @@ -143,6 +144,12 @@ div.tip {margin-left : 5%;margin-right : 5%;padding-left: 2%; padding-right: 2%;

    Long Lines

    Checks for lines that are longer that a specified length. The default is "80". This can be turned off for import statements.

    +

    Method Body Length

    +

    Checks for method bodies that are longer that a specified number of lines. The default is "150". + +

    Constructor Body Length

    +

    Checks for constructor bodies that are longer that a specified number of lines. The default is "150". +

    Tab characters

    Checks for lines that contain tab ('\t') characters. This can be turned off.