source: trunk/checkstyle.xml @ 1378

Revision 1378, 7.2 KB checked in by curtis, 14 years ago (diff)

Add compile targets to build each package separately.
Add target to check style with Checkstyle (still working on it).

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