(no commit message)
authorErik Brakkee <erik@brakkee.org>
Thu, 9 Mar 2006 20:22:57 +0000 (20:22 +0000)
committerErik Brakkee <erik@brakkee.org>
Thu, 9 Mar 2006 20:22:57 +0000 (20:22 +0000)
build/style.xml [new file with mode: 0644]
build/test-style.xml [new file with mode: 0644]

diff --git a/build/style.xml b/build/style.xml
new file mode 100644 (file)
index 0000000..24558dd
--- /dev/null
@@ -0,0 +1,170 @@
+<?xml version="1.0"?>\r
+<!DOCTYPE module PUBLIC\r
+    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"\r
+    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">\r
+\r
+<!--\r
+\r
+  Checkstyle configuration that checks the sun coding conventions from:\r
+\r
+    - the Java Language Specification at\r
+      http://java.sun.com/docs/books/jls/second_edition/html/index.html\r
+\r
+    - the Sun Code Conventions at http://java.sun.com/docs/codeconv/\r
+\r
+    - the Javadoc guidelines at\r
+      http://java.sun.com/j2se/javadoc/writingdoccomments/index.html\r
+\r
+    - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html\r
+\r
+    - some best practices\r
+\r
+  Checkstyle is very configurable. Be sure to read the documentation at\r
+  http://checkstyle.sf.net (or in your downloaded distribution).\r
+\r
+  Most Checks are configurable, be sure to consult the documentation.\r
+\r
+  To completely disable a check, just comment it out or delete it from the file.\r
+\r
+  Finally, it is worth reading the documentation.\r
+\r
+-->\r
+\r
+<module name="Checker">\r
+\r
+    <!-- Checks that a package.html file exists for each package.     -->\r
+    <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->\r
+    <module name="PackageHtml"/>\r
+\r
+    <!-- Checks whether files end with a new line.                        -->\r
+    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->\r
+    <module name="NewlineAtEndOfFile"/>\r
+\r
+    <!-- Checks that property files contain the same keys.         -->\r
+    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->\r
+    <module name="Translation"/>\r
+\r
+\r
+    <module name="TreeWalker">\r
+\r
+        <!-- Checks for Javadoc comments.                     -->\r
+        <!-- See http://checkstyle.sf.net/config_javadoc.html -->\r
+        <module name="JavadocMethod"/>\r
+        <module name="JavadocType"/>\r
+        <module name="JavadocVariable"/>\r
+       <!-- module name="JavadocStyle"/ -->\r
+        \r
+        <!-- Checks for Naming Conventions.                  -->\r
+        <!-- See http://checkstyle.sf.net/config_naming.html -->\r
+        <module name="ConstantName"/>\r
+        <module name="LocalFinalVariableName"/>\r
+        <module name="LocalVariableName"/>\r
+        <module name="MemberName"/>\r
+        <module name="MethodName"/>\r
+        <module name="PackageName"/>\r
+        <module name="ParameterName"/>\r
+        <module name="StaticVariableName"/>\r
+        <module name="TypeName"/>\r
+\r
+\r
+        <!-- Checks for Headers                                -->\r
+        <!-- See http://checkstyle.sf.net/config_header.html   -->\r
+        <!-- <module name="Header">                            -->\r
+            <!-- The follow property value demonstrates the ability     -->\r
+            <!-- to have access to ANT properties. In this case it uses -->\r
+            <!-- the ${basedir} property to allow Checkstyle to be run  -->\r
+            <!-- from any directory within a project. See property      -->\r
+            <!-- expansion,                                             -->\r
+            <!-- http://checkstyle.sf.net/config.html#properties        -->\r
+            <!-- <property                                              -->\r
+            <!--     name="headerFile"                                  -->\r
+            <!--     value="${basedir}/java.header"/>                   -->\r
+        <!-- </module> -->\r
+\r
+        <!-- Following interprets the header file as regular expressions. -->\r
+        <!-- <module name="RegexpHeader"/>                                -->\r
+\r
+\r
+        <!-- Checks for imports                              -->\r
+        <!-- See http://checkstyle.sf.net/config_import.html -->\r
+        <module name="AvoidStarImport"/>\r
+        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->\r
+        <module name="RedundantImport"/>\r
+        <module name="UnusedImports"/>\r
+\r
+\r
+        <!-- Checks for Size Violations.                    -->\r
+        <!-- See http://checkstyle.sf.net/config_sizes.html -->\r
+        <module name="FileLength"/>\r
+        <module name="LineLength"/>\r
+        <module name="MethodLength"/>\r
+        <module name="ParameterNumber"/>\r
+\r
+\r
+        <!-- Checks for whitespace                               -->\r
+        <!-- See http://checkstyle.sf.net/config_whitespace.html -->\r
+        <module name="EmptyForIteratorPad"/>\r
+        <!-- module name="MethodParamPad"/ -->\r
+        <module name="NoWhitespaceAfter"/>\r
+        <module name="NoWhitespaceBefore"/>\r
+        <module name="OperatorWrap"/>\r
+        <module name="ParenPad"/>\r
+        <!-- module name="TypecastParenPad"/ -->\r
+        <module name="TabCharacter"/>\r
+        <module name="WhitespaceAfter"/>\r
+        <module name="WhitespaceAround"/>\r
+\r
+\r
+        <!-- Modifier Checks                                    -->\r
+        <!-- See http://checkstyle.sf.net/config_modifiers.html -->\r
+        <module name="ModifierOrder"/>\r
+        <module name="RedundantModifier"/>\r
+\r
+\r
+        <!-- Checks for blocks. You know, those {}'s         -->\r
+        <!-- See http://checkstyle.sf.net/config_blocks.html -->\r
+        <module name="AvoidNestedBlocks"/>\r
+        <module name="EmptyBlock"/>\r
+        <module name="LeftCurly"/>\r
+        <module name="NeedBraces"/>\r
+        <module name="RightCurly"/>\r
+\r
+\r
+        <!-- Checks for common coding problems               -->\r
+        <!-- See http://checkstyle.sf.net/config_coding.html -->\r
+        <module name="AvoidInlineConditionals"/>\r
+        <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->\r
+        <module name="EmptyStatement"/>\r
+        <module name="EqualsHashCode"/>\r
+        <module name="HiddenField"/>\r
+        <module name="IllegalInstantiation"/>\r
+        <module name="InnerAssignment"/>\r
+        <module name="MagicNumber"/>\r
+        <module name="MissingSwitchDefault"/>\r
+        <module name="RedundantThrows"/>\r
+        <module name="SimplifyBooleanExpression"/>\r
+        <module name="SimplifyBooleanReturn"/>\r
+\r
+        <!-- Checks for class design                         -->\r
+        <!-- See http://checkstyle.sf.net/config_design.html -->\r
+        <module name="DesignForExtension"/>\r
+        <module name="FinalClass"/>\r
+        <module name="HideUtilityClassConstructor"/>\r
+        <module name="InterfaceIsType"/>\r
+        <module name="VisibilityModifier"/>\r
+\r
+\r
+        <!-- Miscellaneous other checks.                   -->\r
+        <!-- See http://checkstyle.sf.net/config_misc.html -->\r
+        <module name="ArrayTypeStyle"/>\r
+        <module name="FinalParameters"/>\r
+        <module name="GenericIllegalRegexp">\r
+            <property name="format" value="\s+$"/>\r
+            <property name="message" value="Line has trailing spaces."/>\r
+        </module>\r
+        <module name="TodoComment"/>\r
+        <module name="UpperEll"/>\r
+\r
+    </module>\r
+\r
+</module>\r
diff --git a/build/test-style.xml b/build/test-style.xml
new file mode 100644 (file)
index 0000000..446472a
--- /dev/null
@@ -0,0 +1,171 @@
+<?xml version="1.0"?>\r
+<!DOCTYPE module PUBLIC\r
+    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"\r
+    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">\r
+\r
+<!--\r
+\r
+  Checkstyle configuration that checks the sun coding conventions from:\r
+\r
+    - the Java Language Specification at\r
+      http://java.sun.com/docs/books/jls/second_edition/html/index.html\r
+\r
+    - the Sun Code Conventions at http://java.sun.com/docs/codeconv/\r
+\r
+    - the Javadoc guidelines at\r
+      http://java.sun.com/j2se/javadoc/writingdoccomments/index.html\r
+\r
+    - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html\r
+\r
+    - some best practices\r
+\r
+  Checkstyle is very configurable. Be sure to read the documentation at\r
+  http://checkstyle.sf.net (or in your downloaded distribution).\r
+\r
+  Most Checks are configurable, be sure to consult the documentation.\r
+\r
+  To completely disable a check, just comment it out or delete it from the file.\r
+\r
+  Finally, it is worth reading the documentation.\r
+\r
+-->\r
+\r
+<module name="Checker">\r
+\r
+    <!-- Checks that a package.html file exists for each package.     -->\r
+    <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->\r
+    <module name="PackageHtml"/>\r
+\r
+    <!-- Checks whether files end with a new line.                        -->\r
+    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->\r
+    <module name="NewlineAtEndOfFile"/>\r
+\r
+    <!-- Checks that property files contain the same keys.         -->\r
+    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->\r
+    <module name="Translation"/>\r
+\r
+\r
+    <module name="TreeWalker">\r
+\r
+        <!-- Checks for Javadoc comments.                     -->\r
+        <!-- See http://checkstyle.sf.net/config_javadoc.html -->\r
+        <module name="JavadocMethod"/>\r
+        <module name="JavadocType"/>\r
+        <module name="JavadocVariable"/>\r
+        <module name="JavadocStyle"/>\r
+\r
+\r
+        <!-- Checks for Naming Conventions.                  -->\r
+        <!-- See http://checkstyle.sf.net/config_naming.html -->\r
+        <module name="ConstantName"/>\r
+        <module name="LocalFinalVariableName"/>\r
+        <module name="LocalVariableName"/>\r
+        <module name="MemberName"/>\r
+        <module name="MethodName"/>\r
+        <module name="PackageName"/>\r
+        <module name="ParameterName"/>\r
+        <module name="StaticVariableName"/>\r
+        <module name="TypeName"/>\r
+\r
+\r
+        <!-- Checks for Headers                                -->\r
+        <!-- See http://checkstyle.sf.net/config_header.html   -->\r
+        <!-- <module name="Header">                            -->\r
+            <!-- The follow property value demonstrates the ability     -->\r
+            <!-- to have access to ANT properties. In this case it uses -->\r
+            <!-- the ${basedir} property to allow Checkstyle to be run  -->\r
+            <!-- from any directory within a project. See property      -->\r
+            <!-- expansion,                                             -->\r
+            <!-- http://checkstyle.sf.net/config.html#properties        -->\r
+            <!-- <property                                              -->\r
+            <!--     name="headerFile"                                  -->\r
+            <!--     value="${basedir}/java.header"/>                   -->\r
+        <!-- </module> -->\r
+\r
+        <!-- Following interprets the header file as regular expressions. -->\r
+        <!-- <module name="RegexpHeader"/>                                -->\r
+\r
+\r
+        <!-- Checks for imports                              -->\r
+        <!-- See http://checkstyle.sf.net/config_import.html -->\r
+        <module name="AvoidStarImport"/>\r
+        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->\r
+        <module name="RedundantImport"/>\r
+        <module name="UnusedImports"/>\r
+\r
+\r
+        <!-- Checks for Size Violations.                    -->\r
+        <!-- See http://checkstyle.sf.net/config_sizes.html -->\r
+        <module name="FileLength"/>\r
+        <module name="LineLength"/>\r
+        <module name="MethodLength"/>\r
+        <module name="ParameterNumber"/>\r
+\r
+\r
+        <!-- Checks for whitespace                               -->\r
+        <!-- See http://checkstyle.sf.net/config_whitespace.html -->\r
+        <module name="EmptyForIteratorPad"/>\r
+        <module name="MethodParamPad"/>\r
+        <module name="NoWhitespaceAfter"/>\r
+        <module name="NoWhitespaceBefore"/>\r
+        <module name="OperatorWrap"/>\r
+        <module name="ParenPad"/>\r
+        <module name="TypecastParenPad"/>\r
+        <module name="TabCharacter"/>\r
+        <module name="WhitespaceAfter"/>\r
+        <module name="WhitespaceAround"/>\r
+\r
+\r
+        <!-- Modifier Checks                                    -->\r
+        <!-- See http://checkstyle.sf.net/config_modifiers.html -->\r
+        <module name="ModifierOrder"/>\r
+        <module name="RedundantModifier"/>\r
+\r
+\r
+        <!-- Checks for blocks. You know, those {}'s         -->\r
+        <!-- See http://checkstyle.sf.net/config_blocks.html -->\r
+        <module name="AvoidNestedBlocks"/>\r
+        <module name="EmptyBlock"/>\r
+        <module name="LeftCurly"/>\r
+        <module name="NeedBraces"/>\r
+        <module name="RightCurly"/>\r
+\r
+\r
+        <!-- Checks for common coding problems               -->\r
+        <!-- See http://checkstyle.sf.net/config_coding.html -->\r
+        <module name="AvoidInlineConditionals"/>\r
+        <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->\r
+        <module name="EmptyStatement"/>\r
+        <module name="EqualsHashCode"/>\r
+        <module name="HiddenField"/>\r
+        <module name="IllegalInstantiation"/>\r
+        <module name="InnerAssignment"/>\r
+        <module name="MagicNumber"/>\r
+        <module name="MissingSwitchDefault"/>\r
+        <module name="RedundantThrows"/>\r
+        <module name="SimplifyBooleanExpression"/>\r
+        <module name="SimplifyBooleanReturn"/>\r
+\r
+        <!-- Checks for class design                         -->\r
+        <!-- See http://checkstyle.sf.net/config_design.html -->\r
+        <module name="DesignForExtension"/>\r
+        <module name="FinalClass"/>\r
+        <module name="HideUtilityClassConstructor"/>\r
+        <module name="InterfaceIsType"/>\r
+        <module name="VisibilityModifier"/>\r
+\r
+\r
+        <!-- Miscellaneous other checks.                   -->\r
+        <!-- See http://checkstyle.sf.net/config_misc.html -->\r
+        <module name="ArrayTypeStyle"/>\r
+        <module name="FinalParameters"/>\r
+        <module name="GenericIllegalRegexp">\r
+            <property name="format" value="\s+$"/>\r
+            <property name="message" value="Line has trailing spaces."/>\r
+        </module>\r
+        <module name="TodoComment"/>\r
+        <module name="UpperEll"/>\r
+\r
+    </module>\r
+\r
+</module>\r