Tweak configure.sh script to pick up newest version of configure classes.
[jnode:svn-mirror.git] / all / jnode_checks.xml
1 <?xml version="1.0"?>\r
2 <!DOCTYPE module PUBLIC\r
3     "-//Puppy Crawl//DTD Check Configuration 1.2//EN"\r
4     "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">\r
5 \r
6 <!--\r
7 \r
8   Checkstyle configuration that checks the sun coding conventions from:\r
9 \r
10     - the Java Language Specification at\r
11       http://java.sun.com/docs/books/jls/second_edition/html/index.html\r
12 \r
13     - the Sun Code Conventions at http://java.sun.com/docs/codeconv/\r
14 \r
15     - the Javadoc guidelines at\r
16       http://java.sun.com/j2se/javadoc/writingdoccomments/index.html\r
17 \r
18     - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html\r
19 \r
20     - some best practices\r
21 \r
22   Checkstyle is very configurable. Be sure to read the documentation at\r
23   http://checkstyle.sf.net (or in your downloaded distribution).\r
24 \r
25   Most Checks are configurable, be sure to consult the documentation.\r
26 \r
27   To completely disable a check, just comment it out or delete it from the file.\r
28 \r
29   Finally, it is worth reading the documentation.\r
30 \r
31 -->\r
32 \r
33 <module name="Checker">\r
34 \r
35     <!-- Checks that a package.html file exists for each package.     -->\r
36     <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->\r
37 <!--    <module name="PackageHtml"/> -->\r
38 \r
39     <!-- Checks whether files end with a new line.                        -->\r
40     <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->\r
41     <module name="NewlineAtEndOfFile"/>\r
42 \r
43     <!-- Checks that property files contain the same keys.         -->\r
44     <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->\r
45 <!--    <module name="Translation"/> -->\r
46 \r
47 \r
48     <module name="TreeWalker">\r
49 \r
50         <!-- Checks for Javadoc comments.                     -->\r
51         <!-- See http://checkstyle.sf.net/config_javadoc.html -->\r
52 <!--        <module name="JavadocMethod"/>\r
53         <module name="JavadocType"/>\r
54         <module name="JavadocVariable"/>\r
55         <module name="JavadocStyle"/> -->\r
56 \r
57 \r
58         <!-- Checks for Naming Conventions.                  -->\r
59         <!-- See http://checkstyle.sf.net/config_naming.html -->\r
60 <!--        <module name="ConstantName"/>\r
61         <module name="LocalFinalVariableName"/>\r
62         <module name="LocalVariableName"/>\r
63         <module name="MemberName"/>\r
64         <module name="MethodName"/>\r
65         <module name="PackageName"/>\r
66         <module name="ParameterName"/>\r
67         <module name="StaticVariableName"/>\r
68         <module name="TypeName"/> -->\r
69 \r
70 \r
71         <!-- Checks for Headers                                -->\r
72         <!-- See http://checkstyle.sf.net/config_header.html   -->\r
73         <!-- <module name="Header">                            -->\r
74             <!-- The follow property value demonstrates the ability     -->\r
75             <!-- to have access to ANT properties. In this case it uses -->\r
76             <!-- the ${basedir} property to allow Checkstyle to be run  -->\r
77             <!-- from any directory within a project. See property      -->\r
78             <!-- expansion,                                             -->\r
79             <!-- http://checkstyle.sf.net/config.html#properties        -->\r
80             <!-- <property                                              -->\r
81             <!--     name="headerFile"                                  -->\r
82             <!--     value="${basedir}/java.header"/>                   -->\r
83         <!-- </module> -->\r
84 \r
85         <!-- Following interprets the header file as regular expressions. -->\r
86         <!-- <module name="RegexpHeader"/>                                -->\r
87 \r
88 \r
89         <!-- Checks for imports                              -->\r
90         <!-- See http://checkstyle.sf.net/config_import.html -->\r
91         <module name="AvoidStarImport"/>\r
92 <!--        <module name="IllegalImport"/> --><!-- defaults to sun.* packages -->\r
93         <module name="RedundantImport"/>\r
94         <module name="UnusedImports"/>\r
95 \r
96 \r
97         <!-- Checks for Size Violations.                    -->\r
98         <!-- See http://checkstyle.sf.net/config_sizes.html -->\r
99 <!--        <module name="FileLength"/>\r
100         <module name="MethodLength"/>\r
101         <module name="ParameterNumber"/> -->\r
102         <module name="LineLength">\r
103             <property name="max" value="120"/>\r
104         </module>\r
105 \r
106 \r
107         <!-- Checks for whitespace                               -->\r
108         <!-- See http://checkstyle.sf.net/config_whitespace.html -->\r
109         <module name="MethodParamPad"/>\r
110         <module name="NoWhitespaceAfter"/>\r
111         <module name="NoWhitespaceBefore"/>\r
112         <!--<module name="OperatorWrap">\r
113             <property name="option" value="eol"/>                \r
114         </module>-->\r
115         <module name="ParenPad"/>\r
116         <module name="TypecastParenPad"/>\r
117         <module name="WhitespaceAfter"/>\r
118         <module name="WhitespaceAround">\r
119             <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN,\r
120             BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,\r
121             EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH,\r
122             LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,\r
123             LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE,\r
124             LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS,\r
125             PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN,\r
126             STAR, STAR_ASSIGN"/>\r
127             <property name="allowEmptyConstructors" value="true"/>\r
128             <property name="allowEmptyMethods" value="true"/>\r
129         </module>\r
130 \r
131         <module name="Indentation"/>\r
132         <module name="TabCharacter"/>\r
133 \r
134         <!-- Modifier Checks                                    -->\r
135         <!-- See http://checkstyle.sf.net/config_modifiers.html -->\r
136 <!--    <module name="RedundantModifier"/> -->\r
137         <module name="ModifierOrder"/>\r
138 \r
139         <!-- Checks for blocks. You know, those {}'s         -->\r
140         <!-- See http://checkstyle.sf.net/config_blocks.html -->        \r
141         <module name="EmptyBlock">\r
142             <property name="option" value="text" />\r
143         </module>\r
144         <module name="LeftCurly"/>\r
145         <module name="RightCurly"/>\r
146         <!--module name="NeedBraces"/-->\r
147         <module name="AvoidNestedBlocks">\r
148             <property name="allowInSwitchCase" value="true" />\r
149         </module>\r
150 \r
151         <!-- Checks for common coding problems               -->\r
152         <!-- See http://checkstyle.sf.net/config_coding.html -->\r
153 <!--        <module name="AvoidInlineConditionals"/>\r
154         <module name="DoubleCheckedLocking"/>\r
155         <module name="EmptyStatement"/>\r
156         <module name="EqualsHashCode"/>\r
157         <module name="HiddenField"/>\r
158         <module name="IllegalInstantiation"/>\r
159         <module name="InnerAssignment"/>\r
160         <module name="MagicNumber"/>\r
161         <module name="MissingSwitchDefault"/>\r
162         <module name="RedundantThrows"/>\r
163         <module name="SimplifyBooleanExpression"/>\r
164         <module name="SimplifyBooleanReturn"/> -->\r
165 \r
166         <!-- Checks for class design                         -->\r
167         <!-- See http://checkstyle.sf.net/config_design.html -->\r
168 <!--        <module name="DesignForExtension"/>\r
169         <module name="FinalClass"/>\r
170         <module name="HideUtilityClassConstructor"/>\r
171         <module name="InterfaceIsType"/>\r
172         <module name="VisibilityModifier"/> -->\r
173 \r
174 \r
175         <!-- Miscellaneous other checks.                   -->\r
176         <!-- See http://checkstyle.sf.net/config_misc.html -->\r
177 <!--        <module name="ArrayTypeStyle"/>\r
178         <module name="FinalParameters"/>\r
179         <module name="GenericIllegalRegexp">\r
180             <property name="format" value="\s+$"/>\r
181             <property name="message" value="Line has trailing spaces."/>\r
182         </module>\r
183         <module name="TodoComment"/>\r
184         <module name="UpperEll"/> -->\r
185 \r
186     </module>\r
187 \r
188 </module>\r