source: tags/loci-tools-2007-Aug-01/checkstyle.xml @ 3027

Revision 3027, 6.5 KB checked in by melissa, 13 years ago (diff)

2007 Aug 01 release of LOCI Tools

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      <property name="header"
70        value="^//$\n^// [0-9A-Za-z]*\.java$\n^//$\n^$\n^/\*$\n^[^\*]*$\n^\*/$\n^$\n^package .*;$"/>
71      <property name="multiLines" value="6, 9, 11, 14"/>
72    </module>
73
74    <!-- Checks for imports                              -->
75    <!-- See http://checkstyle.sf.net/config_import.html -->
76<!--        <module name="AvoidStarImport"/> -->
77    <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
78    <module name="RedundantImport"/>
79    <module name="UnusedImports"/>
80    <module name="ImportOrder"/>
81
82    <!-- Checks for Size Violations.                    -->
83    <!-- See http://checkstyle.sf.net/config_sizes.html -->
84    <module name="FileLength"/>
85    <module name="LineLength"/>
86<!--    <module name="MethodLength"/> -->
87<!--    <module name="ParameterNumber"/> -->
88
89    <!-- Checks for whitespace                               -->
90    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
91    <module name="EmptyForIteratorPad"/>
92    <module name="MethodParamPad"/>
93    <module name="NoWhitespaceAfter"/>
94    <module name="NoWhitespaceBefore"/>
95    <module name="OperatorWrap">
96      <property name="option" value="eol"/>
97    </module>
98    <module name="ParenPad"/>
99    <module name="TypecastParenPad"/>
100    <module name="TabCharacter"/>
101    <module name="WhitespaceAfter"/>
102<!--        <module name="WhitespaceAround"/> -->
103
104    <!-- Modifier Checks                                    -->
105    <!-- See http://checkstyle.sf.net/config_modifiers.html -->
106    <module name="ModifierOrder"/>
107    <module name="RedundantModifier"/>
108
109    <!-- Checks for blocks. You know, those {}'s         -->
110    <!-- See http://checkstyle.sf.net/config_blocks.html -->
111    <module name="AvoidNestedBlocks"/>
112<!--    <module name="EmptyBlock"/> -->
113    <module name="LeftCurly">
114      <property name="option" value="nlow"/>
115    </module>
116<!--    <module name="NeedBraces"/> -->
117    <module name="RightCurly">
118      <property name="option" value="alone"/>
119    </module>
120
121    <!-- Checks for common coding problems               -->
122    <!-- See http://checkstyle.sf.net/config_coding.html -->
123<!--    <module name="AvoidInlineConditionals"/> -->
124    <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
125    <module name="EmptyStatement"/>
126    <module name="EqualsHashCode"/>
127    <module name="HiddenField">
128      <property name="ignoreConstructorParameter" value="true"/>
129      <property name="ignoreSetter" value="true"/>
130    </module>
131    <module name="IllegalInstantiation"/>
132<!--    <module name="InnerAssignment"/> -->
133<!--        <module name="MagicNumber"/> -->
134<!--    <module name="MissingSwitchDefault"/> -->
135    <module name="RedundantThrows"/>
136    <module name="SimplifyBooleanExpression"/>
137    <module name="SimplifyBooleanReturn"/>
138
139    <!-- Checks for class design                         -->
140    <!-- See http://checkstyle.sf.net/config_design.html -->
141<!--    <module name="DesignForExtension"/> -->
142    <module name="FinalClass"/>
143    <module name="HideUtilityClassConstructor"/>
144    <module name="InterfaceIsType"/>
145<!--    <module name="VisibilityModifier"> -->
146<!--      <property name="protectedAllowed" value="true"/> -->
147<!--    </module> -->
148
149    <!-- Miscellaneous other checks.                   -->
150    <!-- See http://checkstyle.sf.net/config_misc.html -->
151    <module name="ArrayTypeStyle"/>
152<!--    <module name="FinalParameters"/> -->
153    <module name="GenericIllegalRegexp">
154      <property name="format" value="\s+$"/>
155      <property name="message" value="Line has trailing spaces."/>
156    </module>
157    <module name="Indentation">
158      <property name="basicOffset" value="2"/>
159      <property name="caseIndent" value="2"/>
160    </module>
161    <module name="TodoComment">
162      <property name="format" value="TODO"/>
163    </module>
164    <module name="UpperEll"/>
165
166    <!-- LOCI custom checks -->
167    <module name="loci.checks.BlankLinesCheck"/>
168
169  </module>
170
171</module>
Note: See TracBrowser for help on using the repository browser.