<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<module name="Checker">

    <property name="severity"           value="warning"/>

    <!-- JDocPackage
    TODO: I don't know if this one is really relevant
    <module name="PackageHtml">
        <property name="severity"   value="error"/>
    </module>
    -->

    <module name="TreeWalker">

         <!-- JDocHtmlValid, JDocHeader -->
        <module name="JavadocStyle">
            <property name="checkFirstSentence" value="false"/>
            <property name="checkEmptyJavadoc"  value="true"/>
            <property name="severity"           value="error"/>
        </module>

        <!-- JDocHeader -->
        <module name="JavadocType">
            <property name="severity"           value="error"/>
        </module>

        <!-- JDocMethod-1, JDocMethod-3, JDocException-1 -->
        <module name="JavadocMethod">
            <property name="severity"   value="error"/>
            <property name="scope"      value="package"/>
            <property name="allowUndeclaredRTE" value="true"/>
            <property name="allowMissingPropertyJavadoc" value="true"/>
        </module>

        <!-- JDocMethod-1 -->
        <module name="JavadocVariable">
            <property name="severity"   value="error"/>
            <property name="scope"      value="package"/>
        </module>

        <!-- AvoidStarImport -->
        <module name="AvoidStarImport">
            <property name="severity"   value="error"/>
        </module>

        <module name="TodoComment">
            <property name="format" value="TODO"/>
        </module>
        <module name="TodoComment">
            <property name="format" value="FUTURE"/>
        </module>
    </module>
    
    <!-- RegexpHeader -->
    <!--
            Assert if header is :
/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */
    -->
    <module name="RegexpHeader">
        <property
            name="header"
            value="^\/\*\*[ ]*$\n^[ ]+\*[ ]+BSD-style license; for more info see http:\/\/pmd.sourceforge.net/license.html[ ]*\n[ ]+\*\/[ ]*$"/>
        <property name="fileExtensions" value="java"/>
    </module>
    <module name="RegexpHeader">
        <property
            name="header"
            value="^#$\n^# BSD-style license; for more info see http:\/\/pmd.sourceforge.net/license.html$\n^#$"/>
        <property name="fileExtensions" value="properties"/>
    </module>
</module>
