cmlenz 2002/12/22 09:55:38
Modified: . checkstyle.xml
Log:
- Group the checkers in sections for better overview
- Enable the 'EualsHashCode' check
Revision Changes Path
1.7 +58 -43 jakarta-cactus/checkstyle.xml
Index: checkstyle.xml
===================================================================
RCS file: /home/cvs/jakarta-cactus/checkstyle.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- checkstyle.xml 20 Dec 2002 21:07:26 -0000 1.6
+++ checkstyle.xml 22 Dec 2002 17:55:38 -0000 1.7
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.0//EN"
"http://www.puppycrawl.com/dtds/configuration_1_0.dtd";>
@@ -6,38 +6,44 @@
<!-- Checkstyle properties for Cactus projects -->
<module name="Checker">
- <property name="tabWidth" value="4" />
-
<module name="TreeWalker">
- <module name="AvoidStarImport"/>
- <module name="ConstantName"/>
- <module name="EmptyBlock">
- <property name="option" value="text"/>
- </module>
- <!-- module name="EqualsHashCode"/ -->
- <module name="FileLength"/>
+
+ <!-- General file checks -->
<module name="Header">
<property name="headerFile" value="${checkstyle.header.file}"/>
</module>
- <module name="IllegalImport"/>
- <module name="IllegalInstantiation"/>
- <module name="InnerAssignment"/>
- <module name="JavadocType">
- <property name="authorFormat" value="\S"/>
- </module>
- <module name="JavadocMethod">
- <property name="checkUnusedThrows" value="true"/>
- </module>
- <module name="JavadocVariable"/>
+ <module name="FileLength"/>
<module name="LineLength">
<property name="ignorePattern" value="(@version|@see)"/>
</module>
- <module name="LocalFinalVariableName"/>
- <module name="LocalVariableName"/>
+ <module name="TabCharacter"/>
+
+ <!-- Imports -->
+ <module name="AvoidStarImport"/>
+ <module name="IllegalImport"/>
+ <module name="RedundantImport"/>
+ <module name="UnusedImports"/>
+
+ <!-- Naming conventions -->
+ <module name="ConstantName"/>
<module name="MemberName"/>
- <module name="MethodLength"/>
<module name="MethodName"/>
- <module name="Modifier"/>
+ <module name="LocalFinalVariableName"/>
+ <module name="LocalVariableName"/>
+ <module name="PackageName"/>
+ <module name="ParameterName">
+ <property name="format" value="^(the|is|has)[A-Z][a-zA-Z0-9]*$"/>
+ </module>
+ <module name="PublicMemberName">
+ <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
+ </module>
+ <module name="StaticVariableName"/>
+ <module name="TypeName"/>
+
+ <!-- Code formatting -->
+ <module name="EmptyBlock">
+ <property name="option" value="text"/>
+ </module>
<module name="NeedBraces"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
@@ -49,41 +55,50 @@
<property name="tokens" value="DOT"/>
<property name="allowLineBreaks" value="true"/>
</module>
- <module name="OperatorWrap"/>
- <module name="OperatorWrap">
+ <module name="OperatorWrap">
<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"/>
<property name="option" value="eol"/>
</module>
- <module name="PackageName"/>
- <module name="ParameterName">
- <property name="format" value="^(the|is|has)[A-Z][a-zA-Z0-9]*$"/>
- </module>
- <module name="ParameterNumber"/>
- <module name="ParenPad"/>
- <module name="PublicMemberName">
- <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
- </module>
- <module name="RedundantImport"/>
- <module name="RedundantModifier"/>
<module name="LeftCurly">
<property name="option" value="nl"/>
</module>
<module name="RightCurly">
<property name="option" value="alone"/>
</module>
+ <module name="WhitespaceAfter"/>
+ <module name="WhitespaceAround"/>
+
+ <!-- Coding style -->
+ <module name="EqualsHashCode"/>
+ <module name="IllegalInstantiation"/>
+ <module name="InnerAssignment"/>
+ <module name="MethodLength"/>
+ <module name="Modifier"/>
+ <module name="ParameterNumber"/>
+ <module name="ParenPad"/>
+ <module name="RedundantModifier"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
- <module name="StaticVariableName"/>
- <module name="TabCharacter"/>
- <module name="TypeName"/>
- <module name="UnusedImports"/>
<module name="UpperEll"/>
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
<property name="publicMemberPattern" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
- <module name="WhitespaceAfter"/>
- <module name="WhitespaceAround"/>
+
+ <!-- Javadoc related checks -->
+ <module name="JavadocType">
+ <property name="scope" value="private"/>
+ <property name="authorFormat" value="\S"/>
+ <property name="versionFormat" value="\$Id.*\$"/>
+ </module>
+ <module name="JavadocMethod">
+ <property name="scope" value="private"/>
+ <property name="checkUnusedThrows" value="true"/>
+ </module>
+ <module name="JavadocVariable">
+ <property name="scope" value="private"/>
+ </module>
+
</module>
</module>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
