RubyGems - git_sniffer - Versions diffs - 0.0.1 - Mend

git_sniffer 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1018) hide show

data/third_party_tools/checkstyle-5.6/site/config.html ADDED Viewed

@@ -0,0 +1,1465 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- Generated by Apache Maven Doxia at Sep 18, 2012 -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>checkstyle -
+    Configuration</title>
+    <style type="text/css" media="all">
+      @import url("./css/maven-base.css");
+      @import url("./css/maven-theme.css");
+      @import url("./css/site.css");
+    </style>
+    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+      <meta name="author" content="Lars Kühne" />
+    <meta name="Date-Revision-yyyymmdd" content="20120918" />
+    <meta http-equiv="Content-Language" content="en" />
+  </head>
+  <body class="composite">
+    <div id="banner">
+                    <div id="bannerLeft">
+                Checkstyle 5.6
+                </div>
+                        <a href="" id="bannerRight" title="Checkstyle">
+                                                <img src="images/logo.png" alt="Checkstyle" />
+                </a>
+            <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="breadcrumbs">
+                <div class="xleft">
+        <span id="publishDate">Last Published: 2012-09-18</span>
+                  &nbsp;| <span id="projectVersion">Version: 5.6</span>
+                      </div>
+            <div class="xright">
+      </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+    <div id="leftColumn">
+      <div id="navcolumn">
+                                <h5>About</h5>
+                  <ul>
+                  <li class="none">
+                          <a href="index.html" title="Checkstyle">Checkstyle</a>
+            </li>
+                  <li class="none">
+                          <a href="releasenotes.html" title="Release Notes">Release Notes</a>
+            </li>
+          </ul>
+                       <h5>Documentation</h5>
+                  <ul>
+                                                                  <li class="expanded">
+            <strong>Configuration</strong>
+                  <ul>
+                      <li class="none">
+                          <a href="property_types.html" title="Property Types">Property Types</a>
+            </li>
+              </ul>
+        </li>
+                                                                                <li class="expanded">
+                          <a href="running.html" title="Running">Running</a>
+                    <ul>
+                      <li class="none">
+                          <a href="anttask.html" title="Ant Task">Ant Task</a>
+            </li>
+                      <li class="none">
+                          <a href="cmdline.html" title="Command Line">Command Line</a>
+            </li>
+              </ul>
+        </li>
+                  <li class="none">
+                          <a href="availablechecks.html" title="Available Checks">Available Checks</a>
+            </li>
+                                                                                                                                                                                                                                                                                                                          <li class="expanded">
+                          <a href="checks.html" title="Standard Checks">Standard Checks</a>
+                    <ul>
+                      <li class="none">
+                          <a href="config_annotation.html" title="Annotations">Annotations</a>
+            </li>
+                      <li class="none">
+                          <a href="config_blocks.html" title="Block Checks">Block Checks</a>
+            </li>
+                      <li class="none">
+                          <a href="config_design.html" title="Class Design">Class Design</a>
+            </li>
+                      <li class="none">
+                          <a href="config_coding.html" title="Coding">Coding</a>
+            </li>
+                      <li class="none">
+                          <a href="config_duplicates.html" title="Duplicate Code">Duplicate Code</a>
+            </li>
+                      <li class="none">
+                          <a href="config_header.html" title="Headers">Headers</a>
+            </li>
+                      <li class="none">
+                          <a href="config_imports.html" title="Imports">Imports</a>
+            </li>
+                      <li class="none">
+                          <a href="config_javadoc.html" title="Javadoc Comments">Javadoc Comments</a>
+            </li>
+                      <li class="none">
+                          <a href="config_metrics.html" title="Metrics">Metrics</a>
+            </li>
+                      <li class="none">
+                          <a href="config_misc.html" title="Miscellaneous">Miscellaneous</a>
+            </li>
+                      <li class="none">
+                          <a href="config_modifier.html" title="Modifiers">Modifiers</a>
+            </li>
+                      <li class="none">
+                          <a href="config_naming.html" title="Naming Conventions">Naming Conventions</a>
+            </li>
+                      <li class="none">
+                          <a href="config_regexp.html" title="Regexp">Regexp</a>
+            </li>
+                      <li class="none">
+                          <a href="config_sizes.html" title="Size Violations">Size Violations</a>
+            </li>
+                      <li class="none">
+                          <a href="config_whitespace.html" title="Whitespace">Whitespace</a>
+            </li>
+              </ul>
+        </li>
+                                                                                                  <li class="expanded">
+                          <a href="extending.html" title="Extending Checkstyle">Extending Checkstyle</a>
+                    <ul>
+                      <li class="none">
+                          <a href="writingchecks.html" title="Writing checks">Writing checks</a>
+            </li>
+                      <li class="none">
+                          <a href="writingfilters.html" title="Writing filters">Writing filters</a>
+            </li>
+                      <li class="none">
+                          <a href="writinglisteners.html" title="Writing listeners">Writing listeners</a>
+            </li>
+              </ul>
+        </li>
+          </ul>
+                       <h5>Developers</h5>
+                  <ul>
+                  <li class="none">
+                          <a href="apidocs/index.html" title="Javadoc">Javadoc</a>
+            </li>
+                  <li class="none">
+                          <a href="http://sourceforge.net/projects/checkstyle" class="externalLink" title="Project Page">Project Page</a>
+            </li>
+                  <li class="none">
+                          <a href="contributing.html" title="Contributing">Contributing</a>
+            </li>
+          </ul>
+                       <h5>Project Documentation</h5>
+                  <ul>
+                                                                                                                                                                                                                                                                          <li class="collapsed">
+                          <a href="project-info.html" title="Project Information">Project Information</a>
+                  </li>
+                                                                    <li class="collapsed">
+                          <a href="project-reports.html" title="Project Reports">Project Reports</a>
+                  </li>
+          </ul>
+                                                                                                                   <a href="http://sourceforge.net/projects/checkstyle" title="SourceForge" class="poweredBy">
+        <img class="poweredBy"  alt="SourceForge" src="http://sflogo.sourceforge.net/sflogo.php?group_id=29721&type=11"    />
+      </a>
+            </div>
+    </div>
+    <div id="bodyColumn">
+      <div id="contentBox">
+    <div class="section"><h2>Overview<a name="Overview"></a></h2>
+      <p>
+        A Checkstyle configuration specifies which <i>modules</i> to
+        plug in and apply to Java source files. Modules are structured
+        in a tree whose root is the <i>Checker</i> module. The next
+        level of modules contains:
+      </p>
+      <ul>
+        <li><i>FileSetChecks</i> - modules that take a set of input
+        files and fire error messages.</li>
+        <li><i>Filters</i>
+        - modules that filter audit events,
+        including error messages, for acceptance.</li>
+        <li><i>AuditListeners</i> - modules that report accepted events.</li>
+      </ul>
+      <p>
+        Many checks are submodules of the <i>TreeWalker</i>
+        FileSetCheck module. The TreeWalker operates by separately
+        transforming each of the Java source files into an abstract
+        syntax tree and then handing the result over to each of its
+        submodules which in turn have a look at certain aspects of the
+        tree.
+      </p>
+      <p>
+        Checkstyle obtains a configuration from an XML document whose
+        elements specify the configuration's hierarchy of modules and
+        their properties. You provide a file that contains the
+        configuration document when you invoke Checkstyle at the <a href="cmdline.html">command line</a>, and when you run a <a href="anttask.html">Checkstyle task</a> in ant. The
+        documentation directory of the Checkstyle distribution contains
+        a sample configuration file <i>sun_checks.xml</i> which
+        configures Checkstyle to check for the Sun coding conventions.
+      </p>
+    </div>
+    <div class="section"><h2>Modules<a name="Modules"></a></h2>
+      <p>
+        A <tt>module</tt> element in the configuration
+        XML document specifies a module identified by the element's
+        <tt>name</tt> attribute.
+      </p>
+      <p>
+        Here is a fragment of a typical configuration document:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;Checker&quot;&gt;
+    &lt;module name=&quot;JavadocPackage&quot;/&gt;
+    &lt;module name=&quot;TreeWalker&quot;&gt;
+        &lt;module name=&quot;AvoidStarImport&quot;/&gt;
+        &lt;module name=&quot;ConstantName&quot;/&gt;
+        &lt;module name=&quot;EmptyBlock&quot;/&gt;
+    &lt;/module&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        In this configuration:
+      </p>
+      <ul>
+        <li>
+          Root module <tt>Checker</tt> has child
+          FileSetChecks <tt>JavadocPackage</tt> and <tt>TreeWalker</tt>. (Module <a href="config_javadoc.html"> <tt>JavadocPackage</tt></a> checks that all packages
+          have package documentation.)
+        </li>
+        <li>
+          Module <tt>TreeWalker</tt> has submodules
+          <tt>AvoidStarImport</tt>, <tt>ConstantName</tt>, and <tt>EmptyBlock</tt>.  (Modules <a href="config_imports.html"><tt>AvoidStarImport</tt></a>, <a href="config_naming.html"><tt>ConstantName</tt></a>, and <a href="config_blocks.html"><tt>EmptyBlock</tt></a> check that a Java source
+          file has no star imports, has valid constant names, and has no
+          empty blocks, respectively.)
+        </li>
+      </ul>
+      <p>
+        For each configuration module, Checkstyle loads a class
+        identified by the <tt>name</tt> attribute of
+        the <tt>module</tt>.  There are several rules
+        for loading a module's class:
+      </p>
+      <ol style="list-style-type: decimal">
+        <li>
+          Load a class directly according to a package-qualified <tt>name</tt>, such as loading class <tt>com.puppycrawl.tools.checkstyle.TreeWalker</tt>
+          for element:
+          <div class="source"><pre>
+&lt;module name=&quot;com.puppycrawl.tools.checkstyle.TreeWalker&quot;&gt;
+          </pre></div>
+          This is useful for plugging third-party modules into a configuration.
+        </li>
+        <li>
+          Load a class of a pre-specified package, such as loading class
+          <tt>com.puppycrawl.tools.checkstyle.checks.AvoidStarImport</tt>
+          for element
+          <div class="source"><pre>
+&lt;module name=&quot;AvoidStarImport&quot;/&gt;
+          </pre></div>
+          Checkstyle applies packages <tt>
+          com.puppycrawl.tools.checkstyle</tt>, <tt>
+          com.puppycrawl.tools.checkstyle.filters</tt>, and <tt> com.puppycrawl.tools.checkstyle.checks</tt>
+          and its sub-packages (only those included in the Checkstyle
+          distribution). You can specify other packages in a <a href="#Packages"><i>package names XML document</i></a>
+          when you invoke Checkstyle at the <a href="cmdline.html">command line</a>, and when you run a <a href="anttask.html">Checkstyle task</a> in ant.
+        </li>
+        <li>
+          Apply the above rules to <tt>name</tt>
+          concatenated with <tt>&quot;Check&quot;</tt>,
+          such as loading class <tt>com.puppycrawl.tools.checkstyle.checks.ConstantNameCheck</tt>
+          for element
+          <div class="source"><pre>
+&lt;module name=&quot;ConstantName&quot;/&gt;
+          </pre></div>
+        </li>
+      </ol>
+    </div>
+    <div class="section"><h2>Properties<a name="Properties"></a></h2>
+      <p>
+        Properties of a module control how the module performs its task.
+        Each module property has a default value, and you are not
+        required to define a property in the configuration document if
+        the default value is satisfactory.  To assign a non-default
+        value to a module's property, define a child <tt>property</tt> element of the <tt>module</tt> element in the configuration XML
+        document. Also provide appropriate <tt>name</tt> and <tt>value</tt>
+        attributes for the <tt>property</tt> element.
+        For example, property <tt>max</tt> of module
+        <tt>MethodLength</tt> specifies the maximum
+        allowable number of lines in a method or constructor, and has
+        default value <tt>150</tt>.  Here is a
+        configuration of module <tt>MethodLength</tt>
+        so that the check reports methods and constructors with more
+        than <tt>60</tt> lines:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;MethodLength&quot;&gt;
+    &lt;property name=&quot;max&quot; value=&quot;60&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        <a href="cmdline.html">Command line</a> properties and ant <a href="anttask.html">Checkstyle task</a> properties apply to the
+        root <tt>Checker</tt> module. Also, properties
+        are inherited in the module hierarchy. These features make it
+        easy to define one property value that applies to many
+        modules. For example, the following configuration fragment
+        specifies that a <tt>tabWidth</tt> of <tt>4</tt> applies to <tt>TreeWalker</tt> and its submodules:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;Checker&quot;&gt;
+    &lt;module name=&quot;JavadocPackage&quot;/&gt;
+    &lt;module name=&quot;TreeWalker&quot;&gt;
+        &lt;property name=&quot;tabWidth&quot; value=&quot;4&quot;/&gt;
+        &lt;module name=&quot;AvoidStarImport&quot;/&gt;
+        &lt;module name=&quot;ConstantName&quot;/&gt;
+        ...
+    &lt;/module&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        The value of a module property can be specified through
+        <i>property expansion</i> with the <tt>${<i>property_name</i>}</tt> notation, where
+        <tt><i>property_name</i></tt> is a <a href="cmdline.html">command line</a> property or an ant <a href="anttask.html">Checkstyle task</a> property.  For example,
+        the following configuration document element gives property
+        <tt>headerFile</tt> the value of command line
+        property <tt>checkstyle.header.file</tt>:
+     </p>
+      <div class="source"><pre>
+&lt;property name=&quot;headerFile&quot; value=&quot;${checkstyle.header.file}&quot;/&gt;
+      </pre></div>
+      <p>
+        You can use property expansion to re-specify a module property
+        value without changing the configuration document.
+      </p>
+      <p>
+        The property element provides an optional <tt>default</tt> attribute which is used when a
+        property in the value cannot be resolved. For example this
+        configuration snippet from a central configuration file checks
+        that methods have javadoc, but allows individual projects to
+        override the severity by specifying their desired value in the
+        command line property <tt>checkstyle.javadoc.severity</tt>:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;JavaDocMethod&quot;&gt;
+  &lt;property name=&quot;severity&quot;
+               value=&quot;${checkstyle.javadoc.severity}&quot;
+               default=&quot;error&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        This feature is a great help when setting up a centralized
+        configuration file (e.g. one file for the whole company) to
+        lower configuration maintenance costs.  Projects that are happy
+        with the default can simply use that configuration file as is,
+        but individual projects with special needs have the flexibility
+        to adjust a few settings to fit their needs without having to
+        copy and maintain the whole configuration.
+      </p>
+    </div>
+    <div class="section"><h2>Checker<a name="Checker"></a></h2>
+      <p>
+        All configurations have root module <tt>Checker</tt>.  <tt>Checker</tt>
+        contains:
+      </p>
+      <ul>
+        <li><i>FileSetCheck</i> children: modules that check sets of
+        files.</li>
+        <li><i>Filter</i> children: modules that filter audit
+        events.</li>
+        <li><i>AuditListener</i> children: modules that report
+        filtered events.</li>
+      </ul>
+      <p>
+        <tt>Checker</tt> also defines properties that are
+        inherited by all other modules of a configuration.
+      </p>
+      <div class="section"><div class="section"><h4>Properties<a name="Properties"></a></h4>
+      <table border="0" class="bodyTable">
+        <tr class="a">
+          <th>name</th>
+          <th>description</th>
+          <th>type</th>
+          <th>default value</th>
+        </tr>
+        <tr class="b">
+          <td>basedir</td>
+          <td>base directory name; stripped off in messages about files</td>
+          <td><a href="property_types.html#string">string</a></td>
+          <td><tt>null</tt></td>
+        </tr>
+        <tr class="a">
+          <td>localeCountry</td>
+          <td>locale country for messages</td>
+          <td><a href="property_types.html#string">string</a>: either
+          the empty string or an uppercase ISO 3166 2-letter code</td>
+          <td>default locale country for the Java Virtual Machine</td>
+        </tr>
+        <tr class="b">
+          <td>localeLanguage</td>
+          <td>locale language for messages</td>
+          <td><a href="property_types.html#string">string</a>: either
+          the empty string or a lowercase ISO 639 code</td>
+          <td>default locale language for the Java Virtual Machine</td>
+        </tr>
+        <tr class="a">
+          <td>charset</td>
+          <td>name of the file charset</td>
+          <td><a href="property_types.html#string">String</a></td>
+          <td>System property &quot;file.encoding&quot;</td>
+        </tr>
+      </table>
+      <p>
+        For example, the following configuration fragment specifies base
+        directory <tt>src/checkstyle</tt> and German
+        locale for all modules:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;Checker&quot;&gt;
+    &lt;property name=&quot;basedir&quot; value=&quot;src/checkstyle&quot;/&gt;
+    &lt;property name=&quot;localeCountry&quot; value=&quot;DE&quot;/&gt;
+    &lt;property name=&quot;localeLanguage&quot; value=&quot;de&quot;/&gt;
+    &lt;module name=&quot;JavadocPackage&quot;/&gt;
+    &lt;module name=&quot;TreeWalker&quot;&gt;
+        ...
+    &lt;/module&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a <tt>Checker</tt> so that it
+        handles files with the <tt>UTF-8</tt> charset:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;Checker&quot;&gt;
+    &lt;property name=&quot;charset&quot; value=&quot;UTF-8&quot;/&gt;
+    ...
+&lt;/module&gt;
+      </pre></div>
+    </div></div></div>
+    <div class="section"><h2>TreeWalker<a name="TreeWalker"></a></h2>
+      <p>
+        FileSetCheck <tt>TreeWalker</tt> checks
+        individual Java source files and defines properties that are
+        applicable to checking such files.
+      </p>
+      <div class="section"><div class="section"><h4>Properties<a name="Properties"></a></h4>
+      <table border="0" class="bodyTable">
+        <tr class="a">
+          <th>name</th>
+          <th>description</th>
+          <th>type</th>
+          <th>default value</th>
+        </tr>
+        <tr class="b">
+          <td>cacheFile</td>
+          <td>caches information about files that have checked ok; used
+          to avoid repeated checks of the same files</td>
+          <td><a href="property_types.html#string">string</a></td>
+          <td><tt>null</tt> (no cache file)</td>
+        </tr>
+        <tr class="a">
+          <td>tabWidth</td>
+          <td>number of expanded spaces for a tab character (<tt>'\t'</tt>); used in messages and Checks that
+          require a tab width, such as <a href="config_sizes.html#LineLength"><tt>LineLength</tt></a></td>
+          <td><a href="property_types.html#integer">integer</a></td>
+          <td><tt>8</tt></td>
+        </tr>
+        <tr class="b">
+          <td>fileExtensions</td>
+          <td>file type extension to identify java files. Setting this
+          property is typically only required if your java source code
+          is preprocessed before compilation and the original files do
+          not have the extension <tt>.java</tt></td>
+          <td><a href="property_types.html#stringSet">String Set</a></td>
+          <td><tt>java</tt></td>
+        </tr>
+      </table>
+      <p>
+        For example, the following configuration fragment specifies
+        <tt>TreeWalker</tt> cache file <tt>target/cachefile</tt>, and a <tt>tabWidth</tt> of <tt>4</tt>:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;Checker&quot;&gt;
+    &lt;module name=&quot;TreeWalker&quot;&gt;
+        &lt;property name=&quot;cacheFile&quot; value=&quot;target/cachefile&quot;/&gt;
+        &lt;property name=&quot;tabWidth&quot; value=&quot;4&quot;/&gt;
+        ...
+    &lt;/module&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        <!-- thanks to Paul King for this example, see
+          https://sourceforge.net/tracker/?func=detail&aid=865610&group_id=29721&atid=397078 -->
+        To integrate Checkstyle with BEA Weblogic Workshop 8.1:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;Checker&quot;&gt;
+    &lt;module name=&quot;TreeWalker&quot;&gt;
+        &lt;property name=&quot;fileExtensions&quot; value=&quot;java,ejb,jpf&quot;/&gt;
+        ...
+      </pre></div>
+    </div></div></div>
+    <div class="section"><h2>TreeWalker Checks<a name="TreeWalker_Checks"></a></h2>
+      <p>
+        The <tt>TreeWalker</tt> module creates a syntax
+        tree for a Java source file and invokes its submodules, called
+        <i>Checks</i>, during a walk, or traversal, of the nodes of
+        the tree.  Every node of the syntax tree has a token. A visit to
+        a node during the traversal triggers all Checks that are
+        configured for its token.  For example, if Check <tt>MethodLength</tt> has been configured as a
+        submodule of <tt>TreeWalker</tt>, then a visit
+        to a node with a method or a constructor definition token
+        triggers <tt>MethodLength</tt> to check the
+        number of lines of the node's code block.
+      </p>
+      <p>
+        Some Checks, such as <tt>FileLength</tt> and
+        <tt>LineLength</tt>, apply directly to the
+        source file and do not involve tokens of the syntax tree.  Other
+        Checks are associated with configurable sets of tokens that
+        trigger the Checks.  For example, this element configures Check
+        <tt>MethodLength</tt>:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;MethodLength&quot;/&gt;
+      </pre></div>
+      <p>
+        The default token set for <tt>MethodLength</tt>
+        is <tt>{METHOD_DEF, CTOR_DEF}</tt>, method
+        definition and constructor definition tokens, so <tt>TreeWalker</tt> invokes <tt>MethodLength</tt> whenever it visits a node with
+        a <tt>METHOD_DEF</tt> or a <tt>CTOR_DEF</tt> token.
+      </p>
+      <p>
+        You specify the trigger tokens for a Check with property <tt>tokens</tt>.  The value of <tt>tokens</tt> is a list that denotes a subset of
+        the Check's tokens, as in the following element that configures
+        Check <tt>MethodLength</tt> to check the number
+        of lines of methods only:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;MethodLength&quot;&gt;
+    &lt;property name=&quot;tokens&quot; value=&quot;METHOD_DEF&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To apply particular properties to different subsets of tokens
+        for a Check, repeat the Check.  For example, to check that the
+        length of each method is at most 150 lines (the default value of
+        <tt>MethodLength</tt> property <tt>max</tt>) and the length of each constructor is
+        at most 60 lines, include the following in the <tt>TreeWalker</tt> configuration:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;MethodLength&quot;&gt;
+    &lt;property name=&quot;tokens&quot; value=&quot;METHOD_DEF&quot;/&gt;
+&lt;/module&gt;
+        &lt;module name=&quot;MethodLength&quot;&gt;
+    &lt;property name=&quot;tokens&quot; value=&quot;CTOR_DEF&quot;/&gt;
+    &lt;property name=&quot;max&quot; value=&quot;60&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        Configurations of the Checks are specified in the pages under <a href="checks.html">here</a>.
+      </p>
+    </div>
+    <div class="section"><h2>Severity<a name="Severity"></a></h2>
+      <p>
+        Each check has a <a href="property_types.html#severity">severity</a> property that a
+        Checkstyle audit assigns to all violations of the check. The
+        default severity level of a check is <tt>error</tt>.
+      </p>
+      <p>
+        You can use the severity property to control the output of the
+        plain formatter for the <a href="cmdline.html">command line
+        tool</a> and the <a href="anttask.html">ANT task</a>. The plain
+        formatter does not report violations with severity level <tt>ignore</tt>, and notes violations with
+        severity level <tt>warning</tt>. For
+        example, according to the following configuration fragment, the
+        plain formatter outputs warnings for translation violations:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;Translation&quot;&gt;
+    &lt;property name=&quot;severity&quot; value=&quot;warning&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        The XML formatter reports the severity level of every violation
+        as an attribute of the violation's <tt>error</tt> element.
+      </p>
+    </div>
+    <div class="section"><h2>Custom messages<a name="Custom_messages"></a></h2>
+      <p>
+        As of Checkstyle 5 all checks can be configured to report
+        custom, configuration specific messages instead of the
+        Checkstyle default messages.  This can be useful in cases where
+        the check message should reference corresponding sections in a
+        coding style document or the default is too generic for
+        developers to understand.
+      </p>
+      <p>An example usage is:</p>
+      <div class="source"><pre>
+&lt;module name=&quot;MemberName&quot;&gt;
+    &lt;property name=&quot;format&quot; value=&quot;^m[a-zA-Z0-9]*$&quot;/&gt;
+    &lt;message key=&quot;name.invalidPattern&quot;
+             value=&quot;Member ''{0}'' must start with a lowercase ''m'' (checked pattern ''{1}'').&quot;
+             /&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        Each check configuration element can zero or more <tt>message</tt> elements. Every check uses one or
+        more distinct message keys to log violations. If you want to
+        customize a certain message you need to specify the message key
+        in the <tt>key</tt> attribute of the <tt>message</tt> element.
+      </p>
+      <p>
+        The <tt>value</tt> attribute specifies the
+        custom message pattern, as shown in the example above.
+        Placeholders used in the default message can also be used in the
+        custom message.  Note that the message pattern must be a valid
+        <tt>java.text.MessageFormat</tt> style pattern,
+        so be careful about curly braces outside a placeholder
+        definition.
+      </p>
+      <p>
+        The obvious question is how do you know which message keys a
+        Check uses, so that you can override them? Well, that is the
+        tricky part. To find out which keys a Check uses you currently
+        need to look into the Check's source code, in conjunction with
+        the Check's <tt>messages.properties</tt> file.
+        Tools/plugins might come to the rescue on this topic, so have a
+        look there.
+      </p>
+    </div>
+    <div class="section"><h2>Filters<a name="Filters"></a></h2>
+      <p>
+        A Checker module has a set of Filter submodules to filter audit
+        events, including the error messages fired by Checks.  A Filter
+        can accept or reject an audit event. If all Filters accept an
+        audit event, then the Checker reports the event.  If any Filter
+        rejects an event, then the Checker does not report the
+        event.
+      </p>
+      <div class="section"><h3>SeverityMatchFilter<a name="SeverityMatchFilter"></a></h3>
+        <p>
+          Filter <tt>SeverityMatchFilter</tt> decides
+          audit events according to the <a href="#Severity">severity
+          level</a> of the event.
+        </p>
+        <div class="section"><div class="section"><h5>SeverityMatchFilter Properties<a name="SeverityMatchFilter_Properties"></a></h5>
+        <table border="0" class="bodyTable">
+          <tr class="a">
+            <th>name</th>
+            <th>description</th>
+            <th>type</th>
+            <th>default value</th>
+          </tr>
+          <tr class="b">
+            <td>severity</td>
+            <td>the severity level of this filter</td>
+            <td><a href="property_types.html#severity">severity</a></td>
+            <td><tt>error</tt></td>
+          </tr>
+          <tr class="a">
+            <td>acceptOnMatch</td>
+            <td>
+              If acceptOnMatch is <tt>true</tt>, then
+              the filter accepts an audit event if and only if there is
+              a match between the event's severity level and property
+              severity. If acceptOnMatch
+              is <tt>false</tt>, then the filter
+              accepts an audit event if and only if there is not a match
+              between the event's severity level and property severity.
+            </td>
+            <td><a href="property_types.html#boolean">boolean</a></td>
+            <td><tt>true</tt></td>
+          </tr>
+        </table>
+        <p>
+          For example, the following configuration fragment directs the
+          Checker to not report audit events with severity
+          level <tt>info</tt>:
+        </p>
+        <div class="source"><pre>
+&lt;module name=&quot;SeverityMatchFilter&quot;&gt;
+    &lt;property name=&quot;severity&quot; value=&quot;info&quot;/&gt;
+    &lt;property name=&quot;acceptOnMatch&quot; value=&quot;false&quot;/&gt;
+&lt;/module&gt;
+        </pre></div>
+      </div></div></div>
+      <div class="section"><h3>SuppressionFilter<a name="SuppressionFilter"></a></h3>
+        <p>
+          Filter <tt>SuppressionFilter</tt> rejects
+          audit events for Check errors according to
+          a <a href="#XML_Details"><i>suppressions XML
+          document</i></a> in a file. If there is no configured
+          suppressions file, the Filter accepts all audit events.
+        </p>
+        <div class="section"><div class="section"><h5>SuppressionFilter Properties<a name="SuppressionFilter_Properties"></a></h5>
+        <table border="0" class="bodyTable">
+          <tr class="a">
+            <th>name</th>
+            <th>description</th>
+            <th>type</th>
+            <th>default value</th>
+          </tr>
+          <tr class="b">
+            <td>file</td>
+            <td>
+              the location of the <i>suppressions XML document</i> file.
+              The order the location is checked is:
+              <ol style="list-style-type: decimal">
+                <li>as a filesystem location</li>
+                <li>
+                  if no file found, and the location starts with either
+                  <tt>http://</tt> or <tt>https://</tt>, then it
+                  is interpreted as a URL
+                </li>
+                <li>
+                  if no file found, then passed to the
+                  <tt>ClassLoader.getResource()</tt> method.
+                </li>
+              </ol>
+            </td>
+            <td><a href="property_types.html#string">string</a></td>
+            <td><tt>none</tt></td>
+          </tr>
+        </table>
+        <p>
+          For example, the following configuration fragment directs the
+          Checker to use a <tt>SuppressionFilter</tt>
+          with suppressions
+          file <tt>docs/suppressions.xml</tt>:
+        </p>
+        <div class="source"><pre>
+&lt;module name=&quot;SuppressionFilter&quot;&gt;
+    &lt;property name=&quot;file&quot; value=&quot;docs/suppressions.xml&quot;/&gt;
+&lt;/module&gt;
+        </pre></div>
+        <p>
+          A <a href="#XML_Details"><i>suppressions XML
+          document</i></a> contains a set
+          of <tt>suppress</tt> elements, where
+          each <tt>suppress</tt> element can have the
+          following attributes:
+        </p>
+        <ul>
+          <li>
+            <tt>files</tt> -
+            a <a href="property_types.html#regexp">regular expression</a>
+            matched against the file name associated with an audit
+            event. It is mandatory.
+          </li>
+          <li>
+            <tt>checks</tt> -
+            a <a href="property_types.html#regexp">regular expression</a>
+            matched against the name of the check associated with an audit
+            event. Optional if <tt>id</tt> is specified.
+          </li>
+          <li>
+            <tt>id</tt> -
+            a <a href="property_types.html#string">string</a>
+            matched against the id of the check associated with an audit
+            event. Optional if <tt>checks</tt> is specified.
+          </li>
+          <li>
+            <tt>lines</tt> - a comma-separated list of
+            values, where each value is
+            an <a href="property_types.html#integer">integer</a> or a
+            range of integers denoted by integer-integer. It is optional.
+          </li>
+          <li>
+            <tt>columns</tt> - a comma-separated list of
+            values, where each value is
+            an <a href="property_types.html#integer">integer</a> or a
+            range of integers denoted by integer-integer. It is optional.
+          </li>
+        </ul>
+        <p>
+          Each audit event is checked against
+          each <tt>suppress</tt> element. It is
+          suppressed if all specified attributes match against the audit
+          event.
+        </p>
+        </div><div class="section"><h5>Examples<a name="Examples"></a></h5>
+        <p>
+          For example, the following suppressions XML document directs
+          a <tt>SuppressionFilter</tt> to
+          reject <tt>JavadocStyleCheck</tt> errors for
+          lines 82 and 108 to 122 of
+          file <tt>AbstractComplexityCheck.java</tt>,
+          and <tt>MagicNumberCheck</tt> errors for line
+          221 of file <tt>JavadocStyleCheck.java</tt>:
+        </p>
+        <div class="source"><pre>
+&lt;?xml version=&quot;1.0&quot;?&gt;
+&lt;!DOCTYPE suppressions PUBLIC
+    &quot;-//Puppy Crawl//DTD Suppressions 1.1//EN&quot;
+    &quot;http://www.puppycrawl.com/dtds/suppressions_1_1.dtd&quot;&gt;
+&lt;suppressions&gt;
+    &lt;suppress checks=&quot;JavadocStyleCheck&quot;
+              files=&quot;AbstractComplexityCheck.java&quot;
+              lines=&quot;82,108-122&quot;/&gt;
+    &lt;suppress checks=&quot;MagicNumberCheck&quot;
+              files=&quot;JavadocStyleCheck.java&quot;
+              lines=&quot;221&quot;/&gt;
+&lt;/suppressions&gt;
+        </pre></div>
+        <p>
+          As another example, imagine that a configuration contains the
+          following:
+        </p>
+        <div class="source"><pre>
+&lt;module name=&quot;DescendantToken&quot;&gt;
+    &lt;property name=&quot;id&quot; value=&quot;stringEqual&quot;/&gt;
+    &lt;property name=&quot;tokens&quot; value=&quot;EQUAL,NOT_EQUAL&quot;/&gt;
+    &lt;property name=&quot;limitedTokens&quot; value=&quot;STRING_LITERAL&quot;/&gt;
+    &lt;property name=&quot;maximumNumber&quot; value=&quot;0&quot;/&gt;
+    &lt;property name=&quot;maximumDepth&quot; value=&quot;1&quot;/&gt;
+&lt;/module&gt;
+&lt;module name=&quot;DescendantToken&quot;&gt;
+    &lt;property name=&quot;id&quot; value=&quot;switchNoDefault&quot;/&gt;
+    &lt;property name=&quot;tokens&quot; value=&quot;LITERAL_SWITCH&quot;/&gt;
+    &lt;property name=&quot;maximumDepth&quot; value=&quot;2&quot;/&gt;
+    &lt;property name=&quot;limitedTokens&quot; value=&quot;LITERAL_DEFAULT&quot;/&gt;
+    &lt;property name=&quot;minimumNumber&quot; value=&quot;1&quot;/&gt;
+&lt;/module&gt;
+        </pre></div>
+        <p>
+          Then the following can be used to suppress only the first
+          check and not the second by using
+          the <tt>id</tt> attribute:
+        </p>
+        <div class="source"><pre>
+&lt;suppress id=&quot;stringEqual&quot; files=&quot;SomeTestCode.java&quot;/&gt;
+        </pre></div>
+      </div></div></div>
+      <div class="section"><h3>SuppressionCommentFilter<a name="SuppressionCommentFilter"></a></h3>
+      <div class="section"><h4>SuppressionCommentFilter<a name="SuppressionCommentFilter"></a></h4>
+      <p>
+        Filter <tt>SuppressionCommentFilter</tt> uses
+        pairs of comments to suppress audit events.
+      </p>
+      <p>
+        Rationale: Sometimes there are legitimate reasons for violating
+        a check.  When this is a matter of the code in question and not
+        personal preference, the best place to override the policy is in
+        the code itself.  Semi-structured comments can be associated
+        with the check.  This is sometimes superior to a separate
+        suppressions file, which must be kept up-to-date as the source
+        file is edited.
+      </p>
+      <p>
+        Usage: This filter only works in conjunction with a <tt>FileContentsHolder</tt>, since that check makes
+        the suppression comments in the .java files available <i>sub
+        rosa</i>. A configuration that includes this filter must
+        configure <tt>FileContentsHolder</tt> as a
+        child module of <tt>TreeWalker</tt>.
+      </p>
+      <div class="section"><h5>SuppressionCommentFilter Properties<a name="SuppressionCommentFilter_Properties"></a></h5>
+      <table border="0" class="bodyTable">
+        <tr class="a">
+          <th>name</th>
+          <th>description</th>
+          <th>type</th>
+          <th>default value</th>
+        </tr>
+        <tr class="b">
+          <td>offCommentFormat</td>
+          <td>comment pattern to trigger filter to begin suppression</td>
+          <td><a href="property_types.html#regexp">regular expression</a></td>
+          <td><tt>CHECKSTYLE\:OFF</tt></td>
+        </tr>
+        <tr class="a">
+          <td>onCommentFormat</td>
+          <td>comment pattern to trigger filter to end suppression</td>
+          <td><a href="property_types.html#regexp">regular expression</a></td>
+          <td><tt>CHECKSTYLE\:ON</tt></td>
+        </tr>
+        <tr class="b">
+          <td>checkFormat</td>
+          <td>check pattern to suppress</td>
+          <td><a href="property_types.html#regexp">regular expression</a></td>
+          <td><tt>.*</tt> (all checks)</td>
+        </tr>
+        <tr class="a">
+          <td>messageFormat</td>
+          <td>message pattern to suppress</td>
+          <td><a href="property_types.html#regexp">regular expression</a></td>
+          <td>none</td>
+        </tr>
+        <tr class="b">
+          <td>checkCPP</td>
+          <td>whether to check C++ style comments (<tt>//</tt>)</td>
+          <td><a href="property_types.html#boolean">boolean</a></td>
+          <td><tt>true</tt></td>
+        </tr>
+        <tr class="a">
+          <td>checkC</td>
+          <td>whether to check C style comments (<tt>/* ... */</tt>)</td>
+          <td><a href="property_types.html#boolean">boolean</a></td>
+          <td><tt>true</tt></td>
+        </tr>
+      </table>
+      </div><div class="section"><h5>Restrictions<a name="Restrictions"></a></h5>
+      <p>
+        offCommentFormat and onCommentFormat must have equal <a class="externalLink" href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Matcher.html#groupCount()">paren counts</a>.
+      </p>
+      </div><div class="section"><h5>Examples<a name="Examples"></a></h5>
+      <p>
+        To configure the check that makes comments available to the filter:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;TreeWalker&quot;&gt;
+    ...
+    &lt;module name=&quot;FileContentsHolder&quot;/&gt;
+    ...
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a filter to suppress audit events between a comment
+        containing <tt>CHECKSTYLE:OFF</tt> and a comment containing
+        <tt>CHECKSTYLE:ON</tt>:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressionCommentFilter&quot;/&gt;
+      </pre></div>
+      <p>
+        To configure a filter to suppress audit events between a comment
+        containing line <tt>BEGIN GENERATED CODE</tt> and a comment
+        containing line <tt>END GENERATED CODE</tt>:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressionCommentFilter&quot;&gt;
+    &lt;property name=&quot;offCommentFormat&quot; value=&quot;BEGIN GENERATED CODE&quot;/&gt;
+    &lt;property name=&quot;onCommentFormat&quot; value=&quot;END GENERATED CODE&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a filter so that <tt>// stop constant
+        check</tt> and <tt>// resume constant check</tt> marks
+        legitimate constant names:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressionCommentFilter&quot;&gt;
+    &lt;property name=&quot;offCommentFormat&quot; value=&quot;stop constant check&quot;/&gt;
+    &lt;property name=&quot;onCommentFormat&quot; value=&quot;resume constant check&quot;/&gt;
+    &lt;property name=&quot;checkFormat&quot; value=&quot;ConstantNameCheck&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a filter so that <tt>UNUSED OFF:
+        <i>var</i></tt> and <tt>UNUSED ON: <i>var</i></tt> marks a
+        variable or parameter known not to be used by the code by
+        matching the variable name in the message:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressionCommentFilter&quot;&gt;
+    &lt;property name=&quot;offCommentFormat&quot; value=&quot;UNUSED OFF\: (\w+)&quot;/&gt;
+    &lt;property name=&quot;onCommentFormat&quot; value=&quot;UNUSED ON\: (\w+)&quot;/&gt;
+    &lt;property name=&quot;checkFormat&quot; value=&quot;Unused&quot;/&gt;
+    &lt;property name=&quot;messageFormat&quot; value=&quot;^Unused \w+ '$1'.$&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a filter so that <tt>CSOFF: <i>regexp</i></tt>
+        and <tt>CSN: <i>regexp</i></tt> mark a matching check:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressionCommentFilter&quot;&gt;
+    &lt;property name=&quot;offCommentFormat&quot; value=&quot;CSOFF\: ([\w\|]+)&quot;/&gt;
+    &lt;property name=&quot;onCommentFormat&quot; value=&quot;CSON\: ([\w\|]+)&quot;/&gt;
+    &lt;property name=&quot;checkFormat&quot; value=&quot;$1&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a filter to suppress all audit events between a comment
+        containing <tt>CHECKSTYLE_OFF: ALL</tt> and a comment containing
+        <tt>CHECKSTYLE_OFF: ALL</tt> except for the <i>EqualsHashCode</i> check:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressionCommentFilter&quot;&gt;
+    &lt;property name=&quot;offCommentFormat&quot; value=&quot;CHECKSTYLE_OFF: ALL&quot;/&gt;
+    &lt;property name=&quot;onCommentFormat&quot; value=&quot;CHECKSTYLE_ON: ALL&quot;/&gt;
+    &lt;property name=&quot;checkFormat&quot; value=&quot;^((?!(EqualsHashCode)).)*$&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      </div></div></div>
+      <div class="section"><h3>SuppressWithNearbyCommentFilter<a name="SuppressWithNearbyCommentFilter"></a></h3>
+      <div class="section"><h4>SuppressWithNearbyCommentFilter<a name="SuppressWithNearbyCommentFilter"></a></h4>
+      <p>
+        Filter <tt>SuppressWithNearbyCommentFilter</tt> uses
+        individual comments to suppress audit events.
+      </p>
+      <p>
+        Rationale: Same as <tt>SuppressionCommentFilter</tt>.
+        Whereas the SuppressionCommentFilter uses matched pairs of
+        filters to turn on/off comment matching,
+        <tt>SuppressWithNearbyCommentFilter</tt> uses
+        single comments.  This requires fewer lines to mark a region, and
+        may be aesthetically preferable in some contexts.
+      </p>
+      <p>
+        Usage: This filter only works in conjunction with a <tt>FileContentsHolder</tt>, since that check makes
+        the suppression comments in the .java files available <i>sub
+        rosa</i>. A configuration that includes this filter must
+        configure <tt>FileContentsHolder</tt> as a
+        child module of <tt>TreeWalker</tt>.
+      </p>
+      <div class="section"><h5>SuppressWithNearbyCommentFilter Properties<a name="SuppressWithNearbyCommentFilter_Properties"></a></h5>
+      <table border="0" class="bodyTable">
+        <tr class="a">
+          <th>name</th>
+          <th>description</th>
+          <th>type</th>
+          <th>default value</th>
+        </tr>
+        <tr class="b">
+          <td>commentFormat</td>
+          <td>comment pattern to trigger filter to begin suppression</td>
+          <td><a href="property_types.html#regexp">regular expression</a></td>
+          <td><tt>SUPPRESS CHECKSTYLE (\w+)</tt></td>
+        </tr>
+        <tr class="a">
+          <td>checkFormat</td>
+          <td>check pattern to suppress</td>
+          <td><a href="property_types.html#regexp">regular expression</a></td>
+          <td><tt>.*</tt></td>
+        </tr>
+        <tr class="b">
+          <td>messageFormat</td>
+          <td>message pattern to suppress</td>
+          <td><a href="property_types.html#regexp">regular expression</a></td>
+          <td>none</td>
+        </tr>
+        <tr class="a">
+          <td>influenceFormat</td>
+          <td>a negative/zero/positive value that defines the number of
+          lines preceding/at/following the suppression comment</td>
+          <td><a href="property_types.html#regexp">regular expression</a></td>
+          <td><tt>0</tt> (the line containing the comment)</td>
+        </tr>
+        <tr class="b">
+          <td>checkCPP</td>
+          <td>whether to check C++ style comments (<tt>//</tt>)</td>
+          <td><a href="property_types.html#boolean">boolean</a></td>
+          <td><tt>true</tt></td>
+        </tr>
+        <tr class="a">
+          <td>checkC</td>
+          <td>whether to check C style comments (<tt>/* ... */</tt>)</td>
+          <td><a href="property_types.html#boolean">boolean</a></td>
+          <td><tt>true</tt></td>
+        </tr>
+      </table>
+      </div><div class="section"><h5>Examples<a name="Examples"></a></h5>
+      <p>
+        To configure the check that makes comments available to the filter:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;TreeWalker&quot;&gt;
+    ...
+    &lt;module name=&quot;FileContentsHolder&quot;/&gt;
+    ...
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a filter to suppress audit events for <i>check</i>
+        on any line with a comment <tt>SUPPRESS CHECKSTYLE <i>check</i></tt>:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressWithNearbyCommentFilter&quot;/&gt;
+      </pre></div>
+      <p>
+        To configure a filter to suppress all audit events on any line
+        containing the comment <tt>CHECKSTYLE IGNORE THIS LINE</tt>:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressWithNearbyCommentFilter&quot;&gt;
+    &lt;property name=&quot;commentFormat&quot; value=&quot;CHECKSTYLE IGNORE THIS LINE&quot;/&gt;
+    &lt;property name=&quot;checkFormat&quot; value=&quot;.*&quot;/&gt;
+    &lt;property name=&quot;influenceFormat&quot; value=&quot;0&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a filter so that
+        <tt>// Ok to catch (Throwable|Exception|RuntimeException) here</tt>
+        permits the current and previous line to avoid generating an IllegalCatch
+        audit event:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressWithNearbyCommentFilter&quot;&gt;
+    &lt;property name=&quot;commentFormat&quot; value=&quot;Ok to catch (\w+) here&quot;/&gt;
+    &lt;property name=&quot;checkFormat&quot; value=&quot;IllegalCatchCheck&quot;/&gt;
+    &lt;property name=&quot;messageFormat&quot; value=&quot;$1&quot;/&gt;
+    &lt;property name=&quot;influenceFormat&quot; value=&quot;-1&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      <p>
+        To configure a filter so that <tt>CHECKSTYLE IGNORE <i>check</i> FOR NEXT <i>var</i> LINES</tt>
+        avoids triggering any audits for the given check for the current line and the next <i>var</i> lines
+        (for a total of <i>var</i>+1 lines):
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;SuppressWithNearbyCommentFilter&quot;&gt;
+    &lt;property name=&quot;commentFormat&quot; value=&quot;CHECKSTYLE IGNORE (\w+) FOR NEXT (\d+) LINES&quot;/&gt;
+    &lt;property name=&quot;checkFormat&quot; value=&quot;$1&quot;/&gt;
+    &lt;property name=&quot;influenceFormat&quot; value=&quot;$2&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+      </div></div></div>
+      </div>
+    <div class="section"><h2>AuditListeners<a name="AuditListeners"></a></h2>
+      <p>
+        In addition to an audit reporter for text or XML output, a
+        Checker can have <a href="writinglisteners.html">custom
+        AuditListeners</a> that handle audit events. In order to use a
+        custom listener, add a <tt>Checker</tt> submodule for the
+        listener and its properties.  For example, to configure a <tt>Checker</tt> so that it uses custom listener <a href="writinglisteners.html#Writing_Listeners">VerboseListener</a> to
+        print audit messages to a file named &quot;audit.txt&quot;,
+        include the following module in the configuration file:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;com.mycompany.listeners.VerboseListener&quot;&gt;
+    &lt;property name=&quot;file&quot; value=&quot;audit.txt&quot;/&gt;
+&lt;/module&gt;
+      </pre></div>
+    </div>
+    <div class="section"><h2>Packages<a name="Packages"></a></h2>
+      <p>
+        Checkstyle loads a module class according to the <tt>name</tt> of a <tt>module</tt>
+        element, and automatically appends pre-specified package
+        prefixes to that <tt>name</tt> in its search
+        for a loadable class.  By default, Checkstyle applies packages
+        <tt> com.puppycrawl.tools.checkstyle</tt>,
+        <tt>
+        com.puppycrawl.tools.checkstyle.filters</tt>, and <tt> com.puppycrawl.tools.checkstyle.checks</tt> as
+        well as any sub-packages of <tt>com.puppycrawl.tools.checkstyle.checks</tt> that
+        are distributed with Checkstyle.
+      </p>
+      <p>
+        To specify other packages to apply,
+        create a <i>package names XML document</i> in a file
+        named <tt>checkstyle_packages.xml</tt>,
+        and provide that file in the root of the .jar containing your
+        custom checks.
+      </p>
+      <p>
+        Note that the support for providing a <i>package names XML document</i>
+        via <a href="cmdline.html">command line</a> option or as a attribute
+        of an <a href="anttask.html">ant Checkstyle task</a> has been dropped
+        with Checkstyle 5.0.
+      </p>
+      <p>
+        A <i>package names XML document</i> specifies a list of
+        package names. Here is a sample package names XML document for
+        packages <tt>
+        com.puppycrawl.tools.checkstyle</tt> and <tt>
+        com.puppycrawl.tools.checkstyle.checks</tt>:
+      </p>
+      <div class="source"><pre>
+&lt;checkstyle-packages&gt;
+  &lt;package name=&quot;com.puppycrawl.tools.checkstyle&quot;&gt;
+    &lt;package name=&quot;checks&quot;/&gt;
+  &lt;/package&gt;
+&lt;/checkstyle-packages&gt;
+      </pre></div>
+      <p>
+        Notice that the packages are specified recursively - a child
+        <tt>package</tt> element is a subpackage of its
+        parent <tt>package</tt> element.
+      </p>
+      <p>
+        For example, to incorporate modules from package <tt>com.mycompany.checks</tt> with Checkstyle
+        modules, create the XML file below and put this file into the
+        <b>root of the jar</b> file which contains your custom check modules.
+        The XML file must be named exactly <tt>checkstyle_packages.xml</tt>:
+      </p>
+      <div class="source"><pre>
+&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+    &lt;!DOCTYPE checkstyle-packages PUBLIC
+    &quot;-//Puppy Crawl//DTD Package Names 1.0//EN&quot;
+    &quot;http://www.puppycrawl.com/dtds/packages_1_0.dtd&quot;&gt;
+&lt;checkstyle-packages&gt;
+  &lt;package name=&quot;com.mycompany.checks&quot;/&gt;
+&lt;/checkstyle-packages&gt;
+      </pre></div>
+      <p>
+        Now you can configure a module of package <tt>com.mycompany.checks</tt>, say <tt>com.mycompany.checks.MethodLimitCheck</tt>, with
+        a shortened <tt>module</tt> element in the
+        configuration document:
+      </p>
+      <div class="source"><pre>
+&lt;module name=&quot;MethodLimit&quot;/&gt;
+      </pre></div>
+      <div class="tip">
+        <div class="section"><div class="section"><h4>Note<a name="Note"></a></h4>
+        <p>
+          As of Checkstyle 5.0 it is unnecessary to repeat the
+          <tt>package</tt> elements for Checkstyle's packages in
+          your custom <tt>checkstyle_packages.xml</tt> file.
+        </p>
+      </div>
+    </div></div></div>
+    <div class="section"><h2>XML Details<a name="XML_Details"></a></h2>
+      <div class="section"><div class="section"><h4>Configuration XML Document<a name="Configuration_XML_Document"></a></h4>
+      <p>
+        The following DTD for a configuration XML document specifies the
+        hierarchy of modules and their properties:
+      </p>
+      <div class="source"><pre>
+&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+&lt;!ELEMENT module (module|property)*&gt;
+&lt;!ATTLIST module name NMTOKEN #REQUIRED&gt;
+&lt;!ELEMENT property EMPTY&gt;
+&lt;!ATTLIST property
+        name NMTOKEN #REQUIRED
+        value CDATA #REQUIRED
+&gt;
+      </pre></div>
+      <p>
+        Checkstyle validates a configuration XML document when it loads
+        the document.  To validate against the above configuration DTD,
+        include the following document type declaration in your
+        configuration XML document:
+      </p>
+      <div class="source"><pre>
+&lt;!DOCTYPE module PUBLIC
+    &quot;-//Puppy Crawl//DTD Check Configuration 1.3//EN&quot;
+    &quot;http://www.puppycrawl.com/dtds/configuration_1_3.dtd&quot;&gt;
+      </pre></div>
+      <p>
+        Checkstyle also strictly enforces the encoding attribute of an
+        XML declaration.  If Checkstyle rejects your configuration
+        document's encoding, correct the value of the encoding
+        attribute, or remove the encoding attribute entirely.
+      </p>
+      <p>
+        For a complete example of a configuration XML document, examine
+        file <tt>docs/sun_checks.xml</tt> that checks the Sun coding
+        conventions.
+      </p>
+      </div><div class="section"><h4>Package Names XML Document<a name="Package_Names_XML_Document"></a></h4>
+      <p>
+        This is a DTD for a package names XML document:
+      </p>
+      <div class="source"><pre>
+&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+&lt;!ELEMENT checkstyle-packages (package)*&gt;
+&lt;!ELEMENT package (package)*&gt;
+&lt;!ATTLIST package name NMTOKEN #REQUIRED&gt;
+      </pre></div>
+      <p>
+        Checkstyle also validates a package names XML document when it
+        loads the document.  To validate against the above package names
+        DTD, include the following document type declaration in your
+        package names XML document:
+      </p>
+      <div class="source"><pre>
+&lt;!DOCTYPE checkstyle-packages PUBLIC
+&quot;-//Puppy Crawl//DTD Package Names 1.1//EN&quot;
+&quot;http://www.puppycrawl.com/dtds/packages_1_1.dtd&quot;&gt;
+      </pre></div>
+      </div><div class="section"><h4>Suppressions XML Document<a name="Suppressions_XML_Document"></a></h4>
+      <p>
+        This is a DTD for a suppressions XML document:
+      </p>
+      <div class="source"><pre>
+&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+&lt;!ELEMENT suppressions (suppress*)&gt;
+&lt;!ELEMENT suppress EMPTY&gt;
+&lt;!ATTLIST suppress files CDATA #REQUIRED
+                   checks CDATA #IMPLIED
+                   id CDATA #IMPLIED
+                   lines CDATA #IMPLIED
+                   columns CDATA #IMPLIED&gt;
+      </pre></div>
+    </div></div></div>
+      </div>
+    </div>
+    <div class="clear">
+      <hr/>
+    </div>
+    <div id="footer">
+      <div class="xright">Copyright &#169;                   2001-2012.
+          All Rights Reserved.
+      </div>
+      <div class="clear">
+        <hr/>
+      </div>
+    </div>
+  </body>
+</html>