From f1c2e34d7456b230608a53fb0bc76f6cda8f64cd Mon Sep 17 00:00:00 2001 From: Rick Giles Date: Mon, 9 Dec 2002 09:42:05 +0000 Subject: [PATCH] beef up Javadoc --- .../checks/JavadocVariableCheck.java | 19 +++++++++-- .../checkstyle/checks/LineLengthCheck.java | 32 ++++++++++++++++++- 2 files changed, 48 insertions(+), 3 deletions(-) diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocVariableCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocVariableCheck.java index c0bc5c20c..c9d4e8dda 100644 --- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocVariableCheck.java +++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocVariableCheck.java @@ -26,8 +26,23 @@ import com.puppycrawl.tools.checkstyle.api.ScopeUtils; import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** - * Checks that a variable has Javadoc comment - * + * Checks that a variable has Javadoc comment. + * The scope to verify is specified using the {@link Scope} class and + * defaults to {@link Scope#PRIVATE}. To verify another scope, + * set property scope to one of the {@link Scope} constants. + * An example of how to configure the check is: + *

+ * 
+ * <config name="JavadocVariableCheck"/>
+ *
+ *

An example of how to configure the check for the + * {@link Scope#PUBLIC} scope is: + *

+ * 
+ * <config name="JavadocVariableCheck">
+ *    <property name="scope" value="public"/>
+ * </config>
+ *
* @author Oliver Burn * @version 1.0 */ diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LineLengthCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LineLengthCheck.java index efed7e862..318c58ea6 100644 --- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LineLengthCheck.java +++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LineLengthCheck.java @@ -39,7 +39,37 @@ import org.apache.commons.beanutils.ConversionException; * has been dropped as it is a special case of regexp: The user can set * the ignorePattern to "^import" and achieve the same effect. *

- * + *

+ * The default maximum allowable line length is 80 characters. To change the + * maximum, set property max. + *

+ *

+ * To ignore lines in the check, set property ignorePattern to a regular + * expression for the lines to ignore. + *

+ *

+ * An example of how to configure the check is: + *

+ * 
+ * <config name="LineLengthCheck"/>
+ *
+ *

An example of how to configure the check to accept lines up to 120 + * characters long is: + *

+ * 
+ * <config name="LineLengthCheck">
+ *    <property name="max" value="120"/>
+ * </config>
+ *
+ *

An example of how to configure the check to ignore lines that begin with + * " * ", such as within a Javadoc comment, is: + *

+ * 
+ * <config name="LineLengthCheck">
+ *    <property name="ignorePattern" value="^ *\* *[^ ]+$"/>
+ * </config>
+ *
+ * * @author Lars Kühne */ public class LineLengthCheck extends Check