source: trunk/checkstyle.xml @ 1388

Revision 1388, 6.0 KB checked in by curtis, 14 years ago (diff)

Some work on style checking targets; fix some style issues.

Line 
1<!--
2checkstyle.xml
3
4Checkstyle configuration file for use with Java software projects at LOCI.
5Run "ant style" to check for source code style deviations.
6-->
7
8<!DOCTYPE module PUBLIC
9  "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
10  "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
11
12<module name="Checker">
13
14  <module name="PackageHtml"/>
15  <module name="NewlineAtEndOfFile"/>
16  <module name="Translation"/>
17
18  <module name="TreeWalker">
19    <!-- Checks for Javadoc comments.                     -->
20    <!-- See http://checkstyle.sf.net/config_javadoc.html -->
21    <module name="JavadocType">
22      <property name="scope" value="package"/>
23      <property name="allowMissingParamTags" value="true"/>
24    </module>
25    <module name="JavadocMethod">
26      <property name="scope" value="package"/>
27      <property name="allowMissingParamTags" value="true"/>
28      <property name="allowMissingThrowsTags" value="true"/>
29      <property name="allowMissingReturnTag" value="true"/>
30      <property name="allowMissingJavadoc" value="true"/>
31    </module>
32<!--
33    <module name="JavadocVariable">
34      <property name="scope" value="package"/>
35    </module>
36-->
37    <module name="JavadocStyle">
38      <property name="scope" value="package"/>
39    </module>
40
41    <!-- Checks for Naming Conventions.                  -->
42    <!-- See http://checkstyle.sf.net/config_naming.html -->
43    <module name="ConstantName"/>
44    <module name="LocalFinalVariableName"/>
45    <module name="LocalVariableName"/>
46    <module name="MemberName"/>
47    <module name="MethodName"/>
48    <module name="PackageName"/>
49    <module name="ParameterName"/>
50    <module name="StaticVariableName"/>
51    <module name="TypeName"/>
52
53    <!-- Checks for Headers                                -->
54    <!-- See http://checkstyle.sf.net/config_header.html   -->
55    <!-- <module name="Header">                            -->
56        <!-- The follow property value demonstrates the ability     -->
57        <!-- to have access to ANT properties. In this case it uses -->
58        <!-- the ${basedir} property to allow Checkstyle to be run  -->
59        <!-- from any directory within a project. See property      -->
60        <!-- expansion,                                             -->
61        <!-- http://checkstyle.sf.net/config.html#properties        -->
62        <!-- <property                                              -->
63        <!--     name="headerFile"                                  -->
64        <!--     value="${basedir}/java.header"/>                   -->
65    <!-- </module> -->
66
67    <!-- Following interprets the header file as regular expressions. -->
68    <!-- <module name="RegexpHeader"/>                                -->
69
70    <!-- Checks for imports                              -->
71    <!-- See http://checkstyle.sf.net/config_import.html -->
72<!--        <module name="AvoidStarImport"/> -->
73    <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
74    <module name="RedundantImport"/>
75    <module name="UnusedImports"/>
76
77    <!-- Checks for Size Violations.                    -->
78    <!-- See http://checkstyle.sf.net/config_sizes.html -->
79    <module name="FileLength"/>
80    <module name="LineLength"/>
81<!--    <module name="MethodLength"/> -->
82<!--    <module name="ParameterNumber"/> -->
83
84    <!-- Checks for whitespace                               -->
85    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
86    <module name="EmptyForIteratorPad"/>
87    <module name="MethodParamPad"/>
88    <module name="NoWhitespaceAfter"/>
89    <module name="NoWhitespaceBefore"/>
90    <module name="OperatorWrap">
91      <property name="option" value="eol"/>
92    </module>
93    <module name="ParenPad"/>
94    <module name="TypecastParenPad"/>
95    <module name="TabCharacter"/>
96    <module name="WhitespaceAfter"/>
97<!--        <module name="WhitespaceAround"/> -->
98
99    <!-- Modifier Checks                                    -->
100    <!-- See http://checkstyle.sf.net/config_modifiers.html -->
101    <module name="ModifierOrder"/>
102    <module name="RedundantModifier"/>
103
104    <!-- Checks for blocks. You know, those {}'s         -->
105    <!-- See http://checkstyle.sf.net/config_blocks.html -->
106    <module name="AvoidNestedBlocks"/>
107<!--    <module name="EmptyBlock"/> -->
108    <module name="LeftCurly">
109      <property name="option" value="nlow"/>
110    </module>
111<!--    <module name="NeedBraces"/> -->
112    <module name="RightCurly">
113      <property name="option" value="alone"/>
114    </module>
115
116    <!-- Checks for common coding problems               -->
117    <!-- See http://checkstyle.sf.net/config_coding.html -->
118<!--    <module name="AvoidInlineConditionals"/> -->
119    <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
120    <module name="EmptyStatement"/>
121    <module name="EqualsHashCode"/>
122    <module name="HiddenField">
123      <property name="ignoreConstructorParameter" value="true"/>
124    </module>
125    <module name="IllegalInstantiation"/>
126<!--    <module name="InnerAssignment"/> -->
127<!--        <module name="MagicNumber"/> -->
128    <module name="MissingSwitchDefault"/>
129    <module name="RedundantThrows"/>
130    <module name="SimplifyBooleanExpression"/>
131    <module name="SimplifyBooleanReturn"/>
132
133    <!-- Checks for class design                         -->
134    <!-- See http://checkstyle.sf.net/config_design.html -->
135<!--    <module name="DesignForExtension"/> -->
136    <module name="FinalClass"/>
137    <module name="HideUtilityClassConstructor"/>
138    <module name="InterfaceIsType"/>
139    <module name="VisibilityModifier">
140      <property name="protectedAllowed" value="true"/>
141    </module>
142
143    <!-- Miscellaneous other checks.                   -->
144    <!-- See http://checkstyle.sf.net/config_misc.html -->
145    <module name="ArrayTypeStyle"/>
146<!--    <module name="FinalParameters"/> -->
147    <module name="GenericIllegalRegexp">
148      <property name="format" value="\s+$"/>
149      <property name="message" value="Line has trailing spaces."/>
150    </module>
151    <module name="TodoComment">
152      <property name="format" value="TODO"/>
153    </module>
154    <module name="UpperEll"/>
155  </module>
156
157</module>
Note: See TracBrowser for help on using the repository browser.