Changeset 1388 for trunk/checkstyle.xml


Ignore:
Timestamp:
08/30/06 14:59:47 (14 years ago)
Author:
curtis
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/checkstyle.xml

    r1378 r1388  
    1 <?xml version="1.0"?> 
     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 
    28<!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 --> 
     9  "-//Puppy Crawl//DTD Check Configuration 1.2//EN" 
     10  "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> 
    3211 
    3312<module name="Checker"> 
    3413 
    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"/> 
     14  <module name="PackageHtml"/> 
     15  <module name="NewlineAtEndOfFile"/> 
     16  <module name="Translation"/> 
    3817 
    39     <!-- Checks whether files end with a new line.                        --> 
    40     <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> 
    41     <module name="NewlineAtEndOfFile"/> 
     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> 
    4240 
    43     <!-- Checks that property files contain the same keys.         --> 
    44     <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> 
    45     <module name="Translation"/> 
     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"/> 
    4652 
     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> --> 
    4766 
    48     <module name="TreeWalker"> 
     67    <!-- Following interprets the header file as regular expressions. --> 
     68    <!-- <module name="RegexpHeader"/>                                --> 
    4969 
    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> 
     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"/> 
    6976 
     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"/> --> 
    7083 
    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"/> 
     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"/> 
    13197<!--        <module name="WhitespaceAround"/> --> 
    13298 
     99    <!-- Modifier Checks                                    --> 
     100    <!-- See http://checkstyle.sf.net/config_modifiers.html --> 
     101    <module name="ModifierOrder"/> 
     102    <module name="RedundantModifier"/> 
    133103 
    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  
     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"/> 
    186114    </module> 
    187115 
     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 
    188157</module> 
Note: See TracChangeset for help on using the changeset viewer.