cs416_checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!-- 
   Checkstyle configuration that checks the CS415 conventions from:
    http://cs.unh.edu/~cs415/javastyle.pdf
 

  Checkstyle is very configurable. Be sure to read the documentation at
  http://checkstyle.sf.net (or in your downloaded distribution).
-->

<module name="Checker">
    
    <!-- Checks for existance of tabs                               -->
    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <!-- "File contains tab characters" (reported only once) -->
    <module name="FileTabCharacter"/>

    
    

    <module name="TreeWalker">
        
         <!-- Checks for indentation                     -->
        <module name="Indentation">
            <property name="basicOffset" value="4"/>
         <!--   needs to be a severity enum <property name="severity" value="1"/> -->
        </module>
        
        
        <!-- Checks for Javadoc comments.                     -->
        <!-- See http://checkstyle.sf.net/config_javadoc.html -->

       <!-- Missing a Javadoc comment ,Expected an @return tag, 
            Expected @param tag for '***'        -->
        <module name="JavadocMethod"/>
        
        <!-- Missing a Javadoc comment , Type Javadoc comment is missing an @author tag.  -->
        <!-- javadoc comment must immediately precede class def -->
        <module name="JavadocType">
            <property name="authorFormat" value="\S"/>
        </module>
        
        
        <!-- Javadoc has empty description section.,  First sentence should end with a period. -->
        <module name="JavadocStyle">
            <property name="checkEmptyJavadoc" value="true"/>
        </module>
        
        
        <!-- Checks for Naming Conventions.                  -->
        <!-- Name 'PerCent' must match pattern '^[a-z][a-zA-Z0-9]*$'.  -->
        <!-- See http://checkstyle.sf.net/config_naming.html -->
        <module name="ConstantName"/>            <!-- static final fields all caps and underscores -->
        <module name="LocalVariableName"/>

        <module name="MemberName">
              <property name="format" value="^_?[a-z][a-zA-Z0-9]*$"/>
        </module>


        <module name="MethodName"/>
        <module name="ParameterName"/>
        <module name="StaticVariableName"/>
        <module name="TypeName"/>


        <!-- Checks for Size Violations.                    -->
        <!-- See http://checkstyle.sf.net/config_sizes.html -->
        <!-- <module name="LineLength"/>  -->
        <module name="LineLength">
            <property name="max" value="80"/>
        </module>


        <!--   150 lines is default -->
        <module name="MethodLength">
            <property name="max" value="100" />
        </module>

        <!-- <module name="ParameterNumber"/> -->


        <!-- Checks for whitespace                               -->
        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
        
        <!--  pad parens -->
         <module name="ParenPad">
            <property name="option" value="space"/>
         </module>
       
        <!--  space after comma   -->
        <module name="WhitespaceAfter">
            <property name="tokens" value="COMMA"/>
        </module>
        
         <!--  spaces around tokens -->
        <module name="WhitespaceAround">
            <property name="tokens" value="ASSIGN, DIV, DIV_ASSIGN, EQUAL,GE, GT, LAND, LCURLY, LE, LOR, LT, MINUS,
                                           MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, RCURLY,
                                           STAR, STAR_ASSIGN"/>
        </module>

        <!-- Checks for blocks. You know, those {}'s         -->
        <!-- See http://checkstyle.sf.net/config_blocks.html -->

        <module name="LeftCurly">
            <property name="option" value="nl"/>
        </module>

        <module name="RightCurly">
            <property name="option" value="alone"/>
            <property name="tokens" value="LITERAL_ELSE"/>
        </module>
        
        <!-- Checks for common coding problems               -->
        <!-- See http://checkstyle.sf.net/config_coding.html -->
        <module name="HiddenField"/>


        <!-- Checks for class design                         -->
        <!-- See http://checkstyle.sf.net/config_design.html -->

        <module name="VisibilityModifier">
            <property name="protectedAllowed" value="true"/>
            <property name="packageAllowed" value="true"/>
        </module>
        
    </module>

</module>