TouchInstinct
/
checkstyle
307
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Changed Javadoc documentation for "config" elements to "module" elements.

This commit is contained in:
Rick Giles 2002-12-16 00:37:36 +00:00
parent 4564aecb5c
commit fa0c0353c2
49 changed files with 126 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/AvoidStarImport.java
View File

@ -35,7 +35,7 @@ import com.puppycrawl.tools.checkstyle.api.FullIdent;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="AvoidStarImport"/&gt;
* &lt;module name="AvoidStarImport"/&gt;
* </pre>
* @author Oliver Burn
* @version 1.0

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/ConstantNameCheck.java
View File

@ -36,7 +36,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="ConstantNameCheck"/&gt;
* &lt;module name="ConstantName"/&gt;
* </pre>
*
* <p>
@ -44,9 +44,9 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* letters and digits is:
* </p>
* <pre>
* &lt;config name="ConstantNameCheck"&gt;
* &lt;module name="ConstantName"&gt;
* &lt;property name="format" value="^[A-Z][A-Z0-9]*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
*

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/EmptyBlockCheck.java
View File

@ -39,17 +39,17 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* <p> An example of how to configure the check is:
* <pre>
* &lt;check
* classname="com.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck"/&gt;
* classname="com.puppycrawl.tools.checkstyle.checks.EmptyBlock"/&gt;
* </pre>
*
* <p> An example of how to configure the check for the {@link
* BlockOption#TEXT} policy and only catch blocks is:
*
* <pre>
* &lt;config name="EmptyBlockCheck"&gt;
* &lt;module name="EmptyBlock"&gt;
* &lt;property name="tokens" value="LITERAL_CATCH"/&gt;
* &lt;property name="option" value="text"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author Lars Kühne

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/EqualsHashCodeCheck.java
View File

@ -44,7 +44,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="EqualsHashCodeCheck"/&gt;
* &lt;module name="EqualsHashCode"/&gt;
* </pre>
* @author lkuehne
*/

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/FileLengthCheck.java
View File

@ -38,16 +38,16 @@ import com.puppycrawl.tools.checkstyle.api.Check;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="FileLengthCheck"/&gt;
* &lt;module name="FileLength"/&gt;
* </pre>
* <p>
* An example of how to configure the check so that it accepts files with at
* most 1500 lines is:
* </p>
* <pre>
* &lt;config name="FileLengthCheck"&gt;
* &lt;module name="FileLength"&gt;
* &lt;property name="max" value="1500"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Lars Kühne
*/

4
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/GenericIllegalRegexpCheck.java
View File

@ -32,9 +32,9 @@ package com.puppycrawl.tools.checkstyle.checks;
* <code>System.out.println</code> is:
* </p>
* <pre>
* &lt;config name="GenericIllegalRegexpCheck"&gt;
* &lt;module name="GenericIllegalRegexp"&gt;
* &lt;property name="format" value="System\.out\.println"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author lkuehne
*/

4
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/HeaderCheck.java
View File

@ -63,10 +63,10 @@ import org.apache.commons.beanutils.ConversionException;
* &quot;java.header&quot; and ignore lines 2, 3, and 4 is:
* </p>
* <pre>
* &lt;config name="HeaderCheck"&gt;
* &lt;module name="Header"&gt;
* &lt;property name="headerFile" value="java.header"/&gt;
* &lt;property name="ignoreLines" value="2, 3, 4"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Lars Kühne
*/

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/HiddenFieldCheck.java
View File

@ -36,16 +36,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="HiddenFieldCheck"/&gt;
* &lt;module name="HiddenField"/&gt;
* </pre>
* <p>
* An example of how to configure the check so that it doesn't check parameters
* is:
* </p>
* <pre>
* &lt;config name="HiddenFieldCheck"&gt;
* &lt;module name="HiddenField"&gt;
* &lt;property name="checkParameters" value="false"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Rick Giles
* @version 1.0

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/IllegalImportCheck.java
View File

@ -38,16 +38,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="IllegalImportCheck"/&gt;
* &lt;module name="IllegalImport"/&gt;
* </pre>
* <p>
* An example of how to configure the check so that it rejects packages
* <code>java.io.*</code> and <code>java.sql.*</code> is
* </p>
* <pre>
* &lt;config name="IllegalImportCheck"&gt;
* &lt;module name="IllegalImport"&gt;
* &lt;property name="illegalPkgs" value="java.io, java.sql"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @author Lars Kühne

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/IllegalInstantiationCheck.java
View File

@ -56,7 +56,7 @@ import antlr.collections.AST;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="IllegalInstantiationCheck"/&gt;
* &lt;module name="IllegalInstantiation"/&gt;
* </pre>
* @author lkuehne
*/

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/InnerAssignmentCheck.java
View File

@ -51,16 +51,16 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* </p>
* <p> An example of how to configure the check is:
* <pre>
* &lt;config name="InnerAssignmentCheck"/&gt;
* &lt;module name="InnerAssignment"/&gt;
* </pre>
*
* <p> An example of how to configure the check for only <code>+</code>,
* <code>+=</code>, and <code>-=</code> operators is:
* </p>
* <pre>
* &lt;config name="InnerAssignmentCheck"&gt;
* &lt;module name="InnerAssignment"&gt;
* &lt;tokens&gt;ASSIGN, PLUS_ASSIGN, MINUS_ASSIGN&lt;/tokens&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author lkuehne

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocMethodCheck.java
View File

@ -48,16 +48,16 @@ import org.apache.regexp.RE;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="JavadocMethodCheck"/&gt;
* &lt;module name="JavadocMethod"/&gt;
* </pre>
* <p> An example of how to configure the check to check for unused imports
* and for the {@link Scope#PUBLIC} scope is:
*</p>
* <pre>
* &lt;config name="JavadocMethodCheck"&gt;
* &lt;module name="JavadocMethod"&gt;
* &lt;property name="scope" value="public"/&gt;
* &lt;property name="checkUnusedThrows" value="true"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>

14
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocTypeCheck.java
View File

@ -46,32 +46,32 @@ import com.puppycrawl.tools.checkstyle.api.Utils;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="JavadocTypeCheck"/&gt;
* &lt;module name="JavadocType"/&gt;
* </pre>
* <p> An example of how to configure the check for the
* {@link Scope#PUBLIC} scope is:
*</p>
* <pre>
* &lt;config name="JavadocTypeCheck"&gt;
* &lt;module name="JavadocType"&gt;
* &lt;property name="scope" value="public"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* <p> An example of how to configure the check for an author tag
* and a version tag is:
*</p>
* <pre>
* &lt;config name="JavadocTypeCheck"&gt;
* &lt;module name="JavadocType"&gt;
* &lt;property name="authorFormat" value="\S"/&gt;
* &lt;property name="versionFormat" value="\S"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* <p> An example of how to configure the check for a
* CVS revision version tag is:
*</p>
* <pre>
* &lt;config name="JavadocTypeCheck"&gt;
* &lt;module name="JavadocType"&gt;
* &lt;property name="versionFormat" value="\$Revision.*\$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/JavadocVariableCheck.java
View File

@ -33,15 +33,15 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="JavadocVariableCheck"/&gt;
* &lt;module name="JavadocVariable"/&gt;
* </pre>
* <p> An example of how to configure the check for the
* {@link Scope#PUBLIC} scope is:
*</p>
* <pre>
* &lt;config name="JavadocVariableCheck"&gt;
* &lt;module name="JavadocVariable"&gt;
* &lt;property name="scope" value="public"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @version 1.0

10
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LineLengthCheck.java
View File

@ -51,24 +51,24 @@ import org.apache.commons.beanutils.ConversionException;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="LineLengthCheck"/&gt;
* &lt;module name="LineLength"/&gt;
* </pre>
* <p> An example of how to configure the check to accept lines up to 120
* characters long is:
*</p>
* <pre>
* &lt;config name="LineLengthCheck"&gt;
* &lt;module name="LineLength"&gt;
* &lt;property name="max" value="120"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* <p> An example of how to configure the check to ignore lines that begin with
* &quot; * &quot;, followed by just one word, such as within a Javadoc comment,
* is:
* </p>
* <pre>
* &lt;config name="LineLengthCheck"&gt;
* &lt;module name="LineLength"&gt;
* &lt;property name="ignorePattern" value="^ *\* *[^ ]+$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author Lars Kühne

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LocalFinalVariableNameCheck.java
View File

@ -34,16 +34,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="LocalFinalVariableNameCheck"/&gt;
* &lt;module name="LocalFinalVariableName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that are only upper case
* letters and digits is:
* </p>
* <pre>
* &lt;config name="LocalFinalVariableNameCheck"&gt;
* &lt;module name="LocalFinalVariableName"&gt;
* &lt;property name="format" value="^[A-Z][A-Z0-9]*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author Rick Giles

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LocalVariableNameCheck.java
View File

@ -35,16 +35,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="LocalVariableNameCheck"/&gt;
* &lt;module name="LocalVariableName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that begin with a lower
* case letter, followed by letters, digits, and underscores is:
* </p>
* <pre>
* &lt;config name="LocalVariableNameCheck"&gt;
* &lt;module name="LocalVariableName"&gt;
* &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Rick Giles
* @version 1.0

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/MemberNameCheck.java
View File

@ -35,7 +35,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="MemberNameCheck"/&gt;
* &lt;module name="MemberName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that begin with
@ -43,9 +43,9 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* digits is:
* </p>
* <pre>
* &lt;config name="MemberNameCheck"&gt;
* &lt;module name="MemberName"&gt;
* &lt;property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Rick Giles
* @version 1.0

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/MethodLeftCurlyCheck.java
View File

@ -34,17 +34,17 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="MethodLeftCurlyCheck"/&gt;
* &lt;module name="MethodLeftCurly"/&gt;
* </pre>
* <p>
* An example of how to configure the check with policy
* {@link LeftCurlyOption#NLOW} and maxLineLength 120 is:
* </p>
* <pre>
* &lt;config name="MethodLeftCurlyCheck"&gt;
* &lt;module name="MethodLeftCurly"&gt;
* &lt;property name="option" value="nlow"/&gt;
* &lt;property name="maxLineLength" value="120"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/MethodLengthCheck.java
View File

@ -39,16 +39,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="MethodLengthCheck"/&gt;
* &lt;module name="MethodLength"/&gt;
* </pre>
* <p>
* An example of how to configure the check so that it accepts methods with at
* most 60 lines is:
* </p>
* <pre>
* &lt;config name="MethodLengthCheck"&gt;
* &lt;module name="MethodLength"&gt;
* &lt;property name="max" value="60"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Lars Kühne
*/

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/MethodNameCheck.java
View File

@ -33,16 +33,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="MethodNameCheck"/&gt;
* &lt;module name="MethodName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that begin with
* a lower case letter, followed by letters, digits, and underscores is:
* </p>
* <pre>
* &lt;config name="MethodNameCheck"&gt;
* &lt;module name="MethodName"&gt;
* &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @version 1.0

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/ModifierCheck.java
View File

@ -60,7 +60,7 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="ModifierCheck"/&gt;
* &lt;module name="Modifier"/&gt;
* </pre>
* @author Lars Kühne
*/

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/NeedBracesCheck.java
View File

@ -39,14 +39,14 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="NeedBracesCheck"/&gt;
* &lt;module name="NeedBraces"/&gt;
* </pre>
* <p> An example of how to configure the check for <code>if</code> and
* <code>else</code> blocks is:
* <pre>
* &lt;config name="NeedBracesCheck"&gt;
* &lt;module name="NeedBraces"&gt;
* &lt;property name="tokens" value="LITERAL_IF, LITERAL_ELSE"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Rick Giles
* @version 1.0

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/NoWhitespaceAfterCheck.java
View File

@ -45,15 +45,15 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="NoWhitespaceAfterCheck"/&gt;
* &lt;module name="NoWhitespaceAfter"/&gt;
* </pre>
* <p> An example of how to configure the check to allow linebreaks after
* a {@link TokenTypes#DOT DOT} token is:
* <pre>
* &lt;config name="NoWhitespaceAfterCheck"&gt;
* &lt;module name="NoWhitespaceAfter"&gt;
* &lt;property name="tokens" value="DOT"/&gt;
* &lt;property name="allowLineBreaks" value="true"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Rick Giles
* @author lkuehne

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/NoWhitespaceBeforeCheck.java
View File

@ -41,15 +41,15 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="NoWhitespaceBeforeCheck"/&gt;
* &lt;module name="NoWhitespaceBefore"/&gt;
* </pre>
* <p> An example of how to configure the check to allow linebreaks before
* a {@link TokenTypes#DOT DOT} token is:
* <pre>
* &lt;config name="NoWhitespaceBeforeCheck"&gt;
* &lt;module name="NoWhitespaceBefore"&gt;
* &lt;property name="tokens" value="DOT"/&gt;
* &lt;property name="allowLineBreaks" value="true"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Rick Giles
* @author lkuehne

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/OperatorWrapCheck.java
View File

@ -70,17 +70,17 @@ import com.puppycrawl.tools.checkstyle.api.Utils;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="OperatorWrapCheck"/&gt;
* &lt;module name="OperatorWrap"/&gt;
* </pre>
* <p> An example of how to configure the check for assignment operators at the
* end of a line is:
* </p>
* <pre>
* &lt;config name="OperatorWrapCheck"&gt;
* &lt;module name="OperatorWrap"&gt;
* &lt;property name="tokens"
* value="ASSIGN,DIV_ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,MOD_ASSIGN,SR_ASSIGN,BSR_ASSIGN,SL_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,BAND_ASSIGN"/&gt;
* &lt;property name="option" value="eol"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author Rick Giles

10
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/OtherLeftCurlyCheck.java
View File

@ -49,17 +49,17 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="OtherLeftCurlyCheck"/&gt;
* &lt;module name="OtherLeftCurly"/&gt;
* </pre>
* <p>
* An example of how to configure the check with policy
* {@link LeftCurlyOption#NLOW} and maxLineLength 120 is:
* </p>
* <pre>
* &lt;config name="OtherLeftCurlyCheck"&gt;
* &lt;module name="OtherLeftCurly"&gt;
* &lt;property name="option" value="nlow"/&gt;
* &lt;property name="maxLineLength" value="120"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* <p>
* An example of how to configure the check with policy
@ -67,10 +67,10 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* is:
* </p>
* <pre>
* &lt;config name="OtherLeftCurlyCheck"&gt;
* &lt;module name="OtherLeftCurly"&gt;
* &lt;property name="option" value="nl"/&gt;
* &lt;property name="tokens" value="LITERAL_IF, LITERAL_ELSE"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/PackageHtmlCheck.java
View File

@ -34,7 +34,7 @@ import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="PackageHtmlCheck"/&gt;
* &lt;module name="PackageHtml"/&gt;
* </pre>
* @author lkuehne
*/

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/PackageNameCheck.java
View File

@ -43,17 +43,17 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="PackageNameCheck"/&gt;
* &lt;module name="PackageName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for package names that begin with
* <code>com.puppycrawl.tools.checkstyle</code> is:
* </p>
* <pre>
* &lt;config name="PackageNameCheck"&gt;
* &lt;module name="PackageName"&gt;
* &lt;property name="format"
* value="^com\.puppycrawl\.tools\.checkstyle(\\.[a-zA-Z_][a-zA-Z_0-9]*)*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/ParameterNameCheck.java
View File

@ -34,16 +34,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="ParameterNameCheck"/&gt;
* &lt;module name="ParameterName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that begin with
* a lower case letter, followed by letters, digits, and underscores is:
* </p>
* <pre>
* &lt;config name="ParameterNameCheck"&gt;
* &lt;module name="ParameterName"&gt;
* &lt;property name="format" value="^^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
*
* @author Oliver Burn

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/ParameterNumberCheck.java
View File

@ -33,15 +33,15 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="ParameterNumberCheck"/&gt;
* &lt;module name="ParameterNumber"/&gt;
* </pre>
* <p>
* An example of how to configure the check to allow 10 parameters is:
* </p>
* <pre>
* &lt;config name="ParameterNumberCheck"&gt;
* &lt;module name="ParameterNumber"&gt;
* &lt;property name="max" value="10"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Oliver Burn

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/ParenPadCheck.java
View File

@ -43,18 +43,18 @@ import com.puppycrawl.tools.checkstyle.api.Utils;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="ParenPadCheck"/&gt;
* &lt;module name="ParenPad"/&gt;
* </pre>
* <p>
* An example of how to configure the check to require spaces for the
* parentheses of constructor, method, and super constructor invocations is:
* </p>
* <pre>
* &lt;config name="ParenPadCheck"&gt;
* &lt;module name="ParenPad"&gt;
* &lt;property name="tokens"
* value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"/&gt;
* &lt;property name="option" value="space"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @version 1.0

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/PublicMemberNameCheck.java
View File

@ -35,16 +35,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="PublicMemberNameCheck"/&gt;
* &lt;module name="PublicMemberName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that begin with
*lower case letter, followed by letters and digits is:
* </p>
* <pre>
* &lt;config name="PublicMemberNameCheck"&gt;
* &lt;module name="PublicMemberName"&gt;
* &lt;property name="format" value="^[a-z][a-zA-Z0-9]*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author Rick Giles

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/RedundantImportCheck.java
View File

@ -43,7 +43,7 @@ import java.util.HashSet;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="RedundantImportCheck"/&gt;
* &lt;module name="RedundantImport"/&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @version 1.0

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/RedundantModifierCheck.java
View File

@ -34,7 +34,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="RedundantModifierCheck"/&gt;
* &lt;module name="RedundantModifier"/&gt;
* </pre>
* @author lkuehne
*/

4
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/RegexpHeaderCheck.java
View File

@ -56,10 +56,10 @@ import com.puppycrawl.tools.checkstyle.api.Utils;
* &quot;java.header&quot; and ignore lines 4 and 5 is:
* </p>
* <pre>
* &lt;config name="RegexpHeaderCheck"&gt;
* &lt;module name="RegexpHeader"&gt;
* &lt;property name="headerFile" value="java.header"/&gt;
* &lt;property name="ignoreLines" value="4, 5"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author Lars Kühne

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/RightCurlyCheck.java
View File

@ -36,17 +36,17 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="RightCurlyCheck"/&gt;
* &lt;module name="RightCurly"/&gt;
* </pre>
* <p>
* An example of how to configure the check with policy
* {@link RightCurlyOption#ALONE} for <code>else</code> tokens is:
* </p>
* <pre>
* &lt;config name="RightCurlyCheck"&gt;
* &lt;module name="RightCurly"&gt;
* &lt;property name="tokens" value="LITERAL_ELSE"/&gt;
* &lt;property name="option" value="alone"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @author lkuehne

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/SimplifyBooleanExpressionCheck.java
View File

@ -35,7 +35,7 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="SimplifyBooleanExpressionCheck"/&gt;
* &lt;module name="SimplifyBooleanExpression"/&gt;
* </pre>
* @author lkuehne
*/

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/SimplifyBooleanReturnCheck.java
View File

@ -34,7 +34,7 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="SimplifyBooleanReturnCheck"/&gt;
* &lt;module name="SimplifyBooleanReturn"/&gt;
* </pre>
* @author Lars Kühne
*/

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/StaticVariableNameCheck.java
View File

@ -35,16 +35,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="StaticVariableNameCheck"/&gt;
* &lt;module name="StaticVariableName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that begin with
* a lower case letter, followed by letters, digits, and underscores is:
* </p>
* <pre>
* &lt;config name="StaticVariableNameCheck"&gt;
* &lt;module name="StaticVariableName"&gt;
* &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Rick Giles
* @version 1.0

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/TabCharacterCheck.java
View File

@ -41,7 +41,7 @@ import com.puppycrawl.tools.checkstyle.api.Check;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="TabCharacterCheck"/&gt;
* &lt;module name="TabCharacter"/&gt;
* </pre>
* @author Lars Kühne
*/

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java
View File

@ -36,16 +36,16 @@ import com.puppycrawl.tools.checkstyle.api.FileContents;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="TodoCommentCheck"/&gt;
* &lt;module name="TodoComment"/&gt;
* </pre>
* <p>
* An example of how to configure the check for comments that contain
* <code>WARNING</code> is:
* </p>
* <pre>
* &lt;config name="TodoCommentCheck"&gt;
* &lt;module name="TodoComment"&gt;
* &lt;property name="format" value="WARNING"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @version 1.0

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java
View File

@ -48,7 +48,7 @@ import com.puppycrawl.tools.checkstyle.Defn;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="TranslationCheck"/&gt;
* &lt;module name="Translation"/&gt;
* </pre>
* @author Alexandra Bunge
* @author lkuehne

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/TypeLeftCurlyCheck.java
View File

@ -33,17 +33,17 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="TypeLeftCurlyCheck"/&gt;
* &lt;module name="TypeLeftCurly"/&gt;
* </pre>
* <p>
* An example of how to configure the check with policy
* {@link LeftCurlyOption#NLOW} and maxLineLength 120 is:
* </p>
* <pre>
* &lt;config name="TypeLeftCurlyCheck"&gt;
* &lt;module name="TypeLeftCurly"&gt;
* &lt;property name="option" value="nlow"/&gt;
* &lt;property name="maxLineLength" value="120"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @author lkuehne

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/TypeNameCheck.java
View File

@ -33,16 +33,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="TypeNameCheck"/&gt;
* &lt;module name="TypeName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that begin with
* a lower case letter, followed by letters, digits, and underscores is:
* </p>
* <pre>
* &lt;config name="TypeNameCheck"&gt;
* &lt;module name="TypeName"&gt;
* &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author Oliver Burn
*/

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/UnusedImportsCheck.java
View File

@ -34,7 +34,7 @@ import java.util.Iterator;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="UnusedImportsCheck"/&gt;
* &lt;module name="UnusedImports"/&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @version 1.0

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java
View File

@ -33,7 +33,7 @@ import com.puppycrawl.tools.checkstyle.api.Check;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="UpperEllCheck"/&gt;
* &lt;module name="UpperEll"/&gt;
* </pre>
* @author Oliver Burn
* @version 1.0

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/WhitespaceAfterCheck.java
View File

@ -35,15 +35,15 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="WhitespaceAfterCheck"/&gt;
* &lt;module name="WhitespaceAfter"/&gt;
* </pre>
* <p> An example of how to configure the check for whitespace only after
* {@link TokenTypes#COMMA COMMA} and {@link TokenTypes#SEMI SEMI} tokens is:
* </p>
* <pre>
* &lt;config name="WhitespaceAfterCheck"&gt;
* &lt;module name="WhitespaceAfter"&gt;
* &lt;property name="tokens" value="COMMA, SEMI"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>
* @author Rick Giles

6
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/WhitespaceAroundCheck.java
View File

@ -79,16 +79,16 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;config name="WhitespaceAroundCheck"/&gt;
* &lt;module name="WhitespaceAround"/&gt;
* </pre>
* <p> An example of how to configure the check for whitespace only around
* assignment operators is:
* </p>
* <pre>
* &lt;config name="WhitespaceAroundCheck"&gt;
* &lt;module name="WhitespaceAround"&gt;
* &lt;property name="tokens"
* value="ASSIGN,DIV_ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,MOD_ASSIGN,SR_ASSIGN,BSR_ASSIGN,SL_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,BAND_ASSIGN"/&gt;
* &lt;/config&gt;
* &lt;/module&gt;
* </pre>
*
* @author <a href="mailto:checkstyle@puppycrawl.com">Oliver Burn</a>