From bf6758b29dbb6f0e22d4951ea3bd25fdf45299fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20K=C3=BChne?= Date: Sun, 11 May 2003 07:31:23 +0000 Subject: [PATCH] documentation improvements from Peter Dobratz --- docs/checkstyle_checks.xml | 2 +- docs/cmdline.html | 5 +- docs/config.html | 1 + docs/config_blocks.html | 87 ++++- docs/config_coding.html | 39 ++- docs/config_design.html | 1 + docs/config_header.html | 1 + docs/config_import.html | 1 + docs/config_javadoc.html | 27 +- docs/config_misc.html | 14 +- docs/config_modifiers.html | 14 +- docs/config_naming.html | 1 + docs/config_sizes.html | 27 +- docs/config_whitespace.html | 329 ++++++++++++++++-- docs/contributing.html | 5 +- docs/property_types.html | 1 + docs/releasenotes.html | 2 + docs/writingchecks.html | 1 + .../tools/checkstyle/api/TokenTypes.java | 42 ++- 19 files changed, 543 insertions(+), 57 deletions(-) diff --git a/docs/checkstyle_checks.xml b/docs/checkstyle_checks.xml index 7a328c42d..8cb307589 100644 --- a/docs/checkstyle_checks.xml +++ b/docs/checkstyle_checks.xml @@ -23,7 +23,7 @@ - + diff --git a/docs/cmdline.html b/docs/cmdline.html index 695ad005b..4a2f434b0 100644 --- a/docs/cmdline.html +++ b/docs/cmdline.html @@ -158,8 +158,7 @@ provide a package names file
-

-Copyright © 2002 Oliver Burn. All rights Reserved. -

+ +

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config.html b/docs/config.html index 6bc8522ed..06b9f1eef 100644 --- a/docs/config.html +++ b/docs/config.html @@ -548,6 +548,7 @@
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_blocks.html b/docs/config_blocks.html index dcb8f07e3..e496bfab1 100644 --- a/docs/config_blocks.html +++ b/docs/config_blocks.html @@ -62,8 +62,26 @@ tokens blocks to check - subset of tokens LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, - LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, STATIC_INIT + + subset of tokens LITERAL_CATCH, + LITERAL_DO, + LITERAL_ELSE, + LITERAL_FINALLY, + LITERAL_IF, + LITERAL_FOR, + LITERAL_TRY, + LITERAL_WHILE, + STATIC_INIT + all tokens @@ -123,9 +141,36 @@ tokens blocks to check - subset of tokens CLASS_DEF, CTOR_DEF, INTERFACE_DEF, LITERAL_CATCH, LITERAL_DO, - LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, - LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF + + subset of tokens CLASS_DEF, + CTOR_DEF, + INTERFACE_DEF, + LITERAL_CATCH, + LITERAL_DO, + LITERAL_ELSE, + LITERAL_FINALLY, + LITERAL_FOR, + LITERAL_IF, + LITERAL_SWITCH, + LITERAL_SYNCHRONIZED, + LITERAL_TRY, + LITERAL_WHILE, + METHOD_DEF + all tokens @@ -169,8 +214,18 @@ tokens blocks to check - subset of tokens LITERAL_DO, LITERAL_ELSE, LITERAL_IF, LITERAL_FOR, - LITERAL_WHILE + + subset of tokens LITERAL_DO, + LITERAL_ELSE, + LITERAL_IF, + LITERAL_FOR, + LITERAL_WHILE + all tokens @@ -223,8 +278,21 @@ tokens blocks to check - subset of tokens LITERAL_CATCH, LITERAL_ELSE, LITERAL_TRY - LITERAL_CATCH, LITERAL_ELSE, LITERAL_TRY + + subset of tokens LITERAL_CATCH, + LITERAL_ELSE, + LITERAL_TRY + + LITERAL_CATCH, + LITERAL_ELSE, + LITERAL_TRY + @@ -309,6 +377,7 @@
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_coding.html b/docs/config_coding.html index b82eabc83..6d0b74bc2 100644 --- a/docs/config_coding.html +++ b/docs/config_coding.html @@ -206,8 +206,15 @@ public class MySingleton tokens tokens to check - subset of tokens PARAMETER_DEF, VARIABLE_DEF - PARAMETER_DEF, VARIABLE_DEF + subset of tokens PARAMETER_DEF, + VARIABLE_DEF + + PARAMETER_DEF, + VARIABLE_DEF

Examples

@@ -312,9 +319,30 @@ public class MySingleton tokens assignments to check - subset of tokens ASSIGN, BAND_ASSIGN, BOR_ASSIGN, BSR_ASSIGN, BXOR_ASSIGN, - DIV_ASSIGN, MINUS_ASSIGN, MOD_ASSIGN, PLUS_ASSIGN, SL_ASSIGN, SR_ASSIGN, - STAR_ASSIGN + subset of tokens ASSIGN, + BAND_ASSIGN, + BOR_ASSIGN, + BSR_ASSIGN, + BXOR_ASSIGN, + DIV_ASSIGN, + MINUS_ASSIGN, + MOD_ASSIGN, + PLUS_ASSIGN, + SL_ASSIGN, + SR_ASSIGN, + STAR_ASSIGN all tokens @@ -489,6 +517,7 @@ return !valid();
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_design.html b/docs/config_design.html index 56b6c6073..c930f0367 100644 --- a/docs/config_design.html +++ b/docs/config_design.html @@ -289,6 +289,7 @@ public class StringUtils // not final to allow subclassing
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_header.html b/docs/config_header.html index 80ce9e073..edcdfa721 100644 --- a/docs/config_header.html +++ b/docs/config_header.html @@ -171,6 +171,7 @@ line 6: /{71}
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_import.html b/docs/config_import.html index 19d6f1d4c..fe47d5aac 100644 --- a/docs/config_import.html +++ b/docs/config_import.html @@ -195,6 +195,7 @@
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_javadoc.html b/docs/config_javadoc.html index 022836dbf..ff038b465 100644 --- a/docs/config_javadoc.html +++ b/docs/config_javadoc.html @@ -116,8 +116,17 @@ tokens definitions to check - subset of tokens INTERFACE_DEF, CLASS_DEF - INTERFACE_DEF, CLASS_DEF + + subset of tokens INTERFACE_DEF, + CLASS_DEF + + INTERFACE_DEF, + CLASS_DEF, + @@ -258,8 +267,17 @@ tokens definitions to check - subset of tokens METHOD_DEF, CTOR_DEF - METHOD_DEF, CTOR_DEF + + subset of tokens METHOD_DEF, + CTOR_DEF + + METHOD_DEF, + CTOR_DEF + @@ -371,6 +389,7 @@ convention of using a
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_misc.html b/docs/config_misc.html index 1ac9e81b7..d21229f0d 100644 --- a/docs/config_misc.html +++ b/docs/config_misc.html @@ -363,8 +363,17 @@ like 1. tokens blocks to check - subset of tokens METHOD_DEF, CTOR_DEF - METHOD_DEF, CTOR_DEF + + subset of tokens METHOD_DEF, + CTOR_DEF + + METHOD_DEF, + CTOR_DEF + @@ -397,6 +406,7 @@ like 1.
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_modifiers.html b/docs/config_modifiers.html index cb6e7428d..5ffaa0428 100644 --- a/docs/config_modifiers.html +++ b/docs/config_modifiers.html @@ -124,8 +124,17 @@ Language specification, section 9.3). tokens tokens to check - subset of tokens METHOD_DEF, VARIABLE_DEF - METHOD_DEF, VARIABLE_DEF + + subset of tokens METHOD_DEF, + VARIABLE_DEF + + METHOD_DEF, + VARIABLE_DEF + @@ -158,6 +167,7 @@ Language specification, section 9.3).
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_naming.html b/docs/config_naming.html index dcbc8f27c..c64149006 100644 --- a/docs/config_naming.html +++ b/docs/config_naming.html @@ -126,6 +126,7 @@
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_sizes.html b/docs/config_sizes.html index 578a3674c..a9ae505e9 100644 --- a/docs/config_sizes.html +++ b/docs/config_sizes.html @@ -194,8 +194,17 @@ tokens blocks to check - subset of tokens METHOD_DEF, CTOR_DEF - METHOD_DEF, CTOR_DEF + + subset of tokens METHOD_DEF, + CTOR_DEF + + METHOD_DEF, + CTOR_DEF + @@ -249,8 +258,17 @@ tokens declarations to check - subset of tokens METHOD_DEF, CTOR_DEF - METHOD_DEF, CTOR_DEF + + subset of tokens METHOD_DEF, + CTOR_DEF + + METHOD_DEF, + CTOR_DEF + @@ -283,6 +301,7 @@
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/config_whitespace.html b/docs/config_whitespace.html index f37324e2e..4234f3b1d 100644 --- a/docs/config_whitespace.html +++ b/docs/config_whitespace.html @@ -73,9 +73,41 @@ tokens tokens to check - subset of tokens ARRAY_INIT, BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, - UNARY_PLUS - ARRAY_INIT, BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS + + subset of tokens ARRAY_INIT, + BNOT, + DEC, + DOT, + INC, + LNOT, + UNARY_MINUS, + UNARY_PLUS + + ARRAY_INIT, + BNOT, + DEC, + DOT, + INC, + LNOT, + UNARY_MINUS, + UNARY_PLUS + @@ -130,8 +162,23 @@ tokens tokens to check - subset of tokens SEMI, DOT, POST_DEC, POST_INC - SEMI, POST_DEC, POST_INC + + subset of tokens SEMI, + DOT, + POST_DEC, + POST_INC + + SEMI, + POST_DEC, + POST_INC + @@ -182,13 +229,122 @@ tokens tokens to check - subset of tokens ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, - BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LE, - LITERAL_INSTANCEOF, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, - PLUS, PLUS_ASSIGN, QUESTION, SL, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN - BAND, BOR, BSR, BXOR, COLON, DIV, EQUAL, GE, GT, LAND, LE, - LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR + + subset of tokens ASSIGN, + BAND, + BAND_ASSIGN, + BOR, + BOR_ASSIGN, + BSR, + BSR_ASSIGN, + BXOR, + BXOR_ASSIGN, + COLON, + DIV, + DIV_ASSIGN, + EQUAL, + GE, + GT, + LAND, + LE, + LITERAL_INSTANCEOF, + LOR, + LT, + MINUS, + MINUS_ASSIGN, + MOD, + MOD_ASSIGN, + NOT_EQUAL, + PLUS, + PLUS_ASSIGN, + QUESTION, + SL, + SL_ASSIGN, + SR, + SR_ASSIGN, + STAR, + STAR_ASSIGN + + BAND, + BOR, + BSR, + BXOR, + COLON, + DIV, + EQUAL, + GE, + GT, + LAND, + LE, + LITERAL_INSTANCEOF, + LOR, + LT, + MINUS, + MOD, + NOT_EQUAL, + PLUS, + QUESTION, + SL, + SR, + STAR (all tokens except assignment operators) + @@ -242,9 +398,33 @@ tokens tokens to check - subset of tokens CTOR_CALL, LPAREN, METHOD_CALL, RPAREN, SUPER_CTOR_CALL, - TYPECAST - CTOR_CALL, LPAREN, METHOD_CALL, RPAREN, SUPER_CTOR_CALL, TYPECAST + + subset of tokens CTOR_CALL, + LPAREN, + METHOD_CALL, + RPAREN, + SUPER_CTOR_CALL, + TYPECAST + + CTOR_CALL, + LPAREN, + METHOD_CALL, + RPAREN, + SUPER_CTOR_CALL, + TYPECAST + @@ -329,8 +509,21 @@ tokens tokens to check - subset of tokens COMMA, SEMI, TYPECAST - COMMA, SEMI, TYPECAST + + subset of tokens COMMA, + SEMI, + TYPECAST + + COMMA, + SEMI, + TYPECAST + @@ -374,13 +567,102 @@ tokens tokens to check - subset of tokens ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, - BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, - LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, - LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, - LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, - PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, - STAR_ASSIGN STAR_ASSIGN + + subset of tokens ASSIGN, + BAND, + BAND_ASSIGN, + BOR, + BOR_ASSIGN, + BSR, + BSR_ASSIGN, + BXOR, + BXOR_ASSIGN, + COLON, + DIV, + DIV_ASSIGN, + EQUAL, + GE, + GT, + LAND, + LCURLY, + LE, + LITERAL_ASSERT, + LITERAL_CATCH, + LITERAL_DO, + LITERAL_ELSE, + LITERAL_FINALLY, + LITERAL_FOR, + LITERAL_IF, + LITERAL_RETURN, + LITERAL_SYNCHRONIZED, + LITERAL_TRY, + LITERAL_WHILE, + LOR, + LT, + MINUS, + MINUS_ASSIGN, + MOD, + MOD_ASSIGN, + NOT_EQUAL, + PLUS, + PLUS_ASSIGN, + QUESTION, + RCURLY, + SL, + SLIST, + SL_ASSIGN, + SR, + SR_ASSIGN, + STAR, + STAR_ASSIGN + all tokens @@ -414,6 +696,7 @@
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/contributing.html b/docs/contributing.html index 9aa324e9d..1ca422699 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -104,12 +104,12 @@ are on Windows). If you have chaged existing files, create a unified diff using CVS. To do that, open a command line, cd to the home directory of checkstyle (where build.xml is located) and execute - cvs diff -u > mychanges.patch. + cvs diff -u > mychanges.patch.

Create a new item in our - patch tracker. + patch tracker. Send an email to the developer mailing list that explains the purpose of your contribution. Be prepared to answer questions and do some polishing work. @@ -128,5 +128,6 @@

+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/property_types.html b/docs/property_types.html index 2a09f92d7..e2e9e54d5 100644 --- a/docs/property_types.html +++ b/docs/property_types.html @@ -252,6 +252,7 @@ valid options:

+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/releasenotes.html b/docs/releasenotes.html index 4b41a1c25..ebfc942be 100644 --- a/docs/releasenotes.html +++ b/docs/releasenotes.html @@ -363,4 +363,6 @@ does not have braces in if-then-else (bug 689836).
+ +

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/docs/writingchecks.html b/docs/writingchecks.html index 4398b9567..9f5bfc928 100644 --- a/docs/writingchecks.html +++ b/docs/writingchecks.html @@ -587,5 +587,6 @@
+

Copyright © 2002-2003 Oliver Burn. All rights Reserved.

diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/api/TokenTypes.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/api/TokenTypes.java index 01b1f2400..b50ed51c2 100644 --- a/src/checkstyle/com/puppycrawl/tools/checkstyle/api/TokenTypes.java +++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/api/TokenTypes.java @@ -1196,9 +1196,47 @@ public final class TokenTypes **/ public static final int LITERAL_NATIVE = 66; /** - * The synchronized keyword. + * The synchronized keyword. This may be used as a + * modifier of a method or in the definition of a synchronized + * block. + * + *

For example:

+ * + * 
+     * synchronized(this)
+     * {
+     *   x++;
+     * }
+     *
+ * + *

parses as:

+ * + * 
+     * +--LITERAL_SYNCHRONIZED (synchronized)
+     *     |
+     *     +--LPAREN (()
+     *     +--EXPR
+     *         |
+     *         +--LITERAL_THIS (this)
+     *     +--RPAREN ())
+     *     +--SLIST ({)
+     *         |
+     *         +--EXPR
+     *             |
+     *             +--POST_INC (++)
+     *                 |
+     *                 +--IDENT (x)
+     *         +--SEMI (;)
+     *         +--RCURLY (})
+     * +--RCURLY (})
+     *
* * @see #MODIFIERS + * @see #LPAREN + * @see #EXPR + * @see #RPAREN + * @see #SLIST + * @see #RCURLY **/ public static final int LITERAL_SYNCHRONIZED = 67; /** @@ -2177,7 +2215,7 @@ public final class TokenTypes * The ~ (bitwise complement) operator. * * @see Java * Language Specification, §15.15.5 * @see #EXPR **/