You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 15:58:28 UTC
svn commit: r816660 [8/33] - in
/websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest:
./ apidocs/ apidocs/org/apache/maven/plugin/checkstyle/
apidocs/org/apache/maven/plugin/checkstyle/class-use/
apidocs/org/apache/maven/plugin...
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-mojo.html Tue May 8 13:58:21 2012
@@ -12,7 +12,8 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Checkstyle Plugin - checkstyle:checkstyle</title>
+ <title>Maven Checkstyle Plugin -
+ checkstyle:checkstyle</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@@ -21,23 +22,23 @@
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
<script type="text/javascript">_uacct = "UA-140879-1";
urchinTracker();</script>
</head>
<body class="composite">
<div id="banner">
- <a href="../../" id="bannerLeft">
+ <a href="http://maven.apache.org/" id="bannerLeft">
- <img src="../../images/apache-maven-project-2.png" alt="" />
+ <img src="http://maven.apache.org/images/apache-maven-project-2.png" alt="" />
</a>
- <a href="../../" id="bannerRight">
+ <span id="bannerRight">
- <img src="../../images/maven-logo-2.gif" alt="" />
+ <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
- </a>
+ </span>
<div class="clear">
<hr/>
</div>
@@ -56,13 +57,13 @@
<a href="http://www.apache.org/" class="externalLink">Apache</a>
>
- <a href="../../index.html">Maven</a>
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
>
- <a href="../index.html">Plugins</a>
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
>
- <a href="http://maven.apache.org/plugins/maven-checkstyle-plugin" class="externalLink">Maven Checkstyle Plugin</a>
+ <a href="../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
</div>
<div class="xright">
@@ -72,8 +73,8 @@
- Last Published: 2010-02-08
- | Version: 2.5
+ Last Published: 2010-09-22
+ | Version: 2.6
</div>
<div class="clear">
<hr/>
@@ -196,47 +197,47 @@
<ul>
<li class="none">
- <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
</li>
<li class="none">
- <a href="../../doxia/index.html">Doxia</a>
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
</li>
<li class="none">
- <a href="../../jxr/index.html">JXR</a>
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
</li>
<li class="none">
- <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
</li>
<li class="none">
- <a href="../../index.html">Maven 2</a>
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
</li>
<li class="none">
- <a href="../../mercury/index.html">Mercury</a>
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
</li>
<li class="none">
- <a href="../index.html">Plugins</a>
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
</li>
<li class="none">
- <a href="../../scm/index.html">SCM</a>
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
</li>
<li class="none">
- <a href="../../shared/index.html">Shared Components</a>
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
</li>
<li class="none">
- <a href="../../surefire/index.html">Surefire</a>
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
</li>
<li class="none">
- <a href="../../wagon/index.html">Wagon</a>
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
@@ -254,592 +255,632 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2><a name="checkstyle:checkstyle"></a>checkstyle:checkstyle</h2>
-<p><strong>Note</strong>:This goal should be used as a Maven report.</p>
-<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.5:checkstyle</p>
-<p><strong>Description</strong>:</p>
-<div>Perform a Checkstyle analysis, and generate a report on violations.</div><p><strong>Attributes</strong>:</p>
-<ul><li>Requires a Maven 2.0 project to be executed.</li>
-<li>Requires dependency resolution of artifacts in scope: <code>compile</code>.</li>
-</ul>
-<div class="section"><h3><a name="Required_Parameters"></a>Required Parameters</h3>
-<table class="bodyTable"><tr class="a"><th>Name</th>
-<th>Type</th>
-<th>Since</th>
-<th>Description</th>
-</tr>
-<tr class="b"><td><strong><a href="#includes">includes</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td>Specifies the names filter of the source files to be used for
-Checkstyle.<br />
-<strong>Default value is</strong>: <code>**/*.java</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#outputDirectory">outputDirectory</a></strong></td>
-<td><code>File</code></td>
-<td><code>-</code></td>
-<td>The output directory for the report. Note that this parameter is
+
+
+ <div class="section"><h2>checkstyle:checkstyle<a name="checkstyle:checkstyle"></a></h2>
+ <p><b>Note</b>:This goal should be used as a Maven report.</p>
+ <p><b>Full name</b>:</p>
+ <p>org.apache.maven.plugins:maven-checkstyle-plugin:2.6:checkstyle</p>
+ <p><b>Description</b>:</p>
+ <div>Perform a Checkstyle analysis, and generate a report on violations.</div>
+ <p><b>Attributes</b>:</p>
+ <ul>
+ <li>Requires a Maven 2.0 project to be executed.</li>
+ <li>Requires dependency resolution of artifacts in scope: <tt>compile</tt>.</li>
+ <li>The goal is thread-safe and supports parallel builds.</li>
+ </ul>
+ <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
+ <table class="bodyTable" border="0" align="left">
+ <tr class="a">
+ <th>Name</th>
+ <th>Type</th>
+ <th>Since</th>
+ <th>Description</th>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#includes">includes</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies the names filter of the source files to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>**/*.java</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td>The output directory for the report. Note that this parameter is
only evaluated if the goal is run directly from the command line.
If the goal is run indirectly as part of a site generation, the
-output directory configured in Maven Site Plugin is used instead.<br />
-<strong>Default value is</strong>: <code>${project.reporting.outputDirectory}</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#sourceDirectory">sourceDirectory</a></strong></td>
-<td><code>File</code></td>
-<td><code>-</code></td>
-<td>Specifies the location of the source directory to be used for
-Checkstyle.<br />
-<strong>Default value is</strong>: <code>${project.build.sourceDirectory}</code>.</td>
-</tr>
-</table>
-</div>
-<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
-<table class="bodyTable"><tr class="a"><th>Name</th>
-<th>Type</th>
-<th>Since</th>
-<th>Description</th>
-</tr>
-<tr class="b"><td><strong><a href="#cacheFile">cacheFile</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td>Specifies the cache file used to speed up Checkstyle on successive
-runs.<br />
-<strong>Default value is</strong>: <code>${project.build.directory}/checkstyle-cachefile</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#configLocation">configLocation</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td><p>Specifies the location of the XML configuration to use.</p>
+output directory configured in Maven Site Plugin is used instead.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies the location of the source directory to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>${project.build.sourceDirectory}</tt>.</td>
+ </tr>
+ </table>
+ </div>
+ <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+ <table class="bodyTable" border="0" align="left">
+ <tr class="a">
+ <th>Name</th>
+ <th>Type</th>
+ <th>Since</th>
+ <th>Description</th>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#cacheFile">cacheFile</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies the cache file used to speed up Checkstyle on successive
+runs.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-cachefile</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#configLocation">configLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td><p>Specifies the location of the XML configuration to use.</p>
+
<p>Potential values are a filesystem path, a URL, or a classpath
resource. This parameter expects that the contents of the location
conform to the xml format (Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Modules">Checker
module</a>) configuration of rulesets.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the configuration is copied
into the
-<code>${project.build.directory}/checkstyle-configuration.xml</code>
+<tt>${project.build.directory}/checkstyle-configuration.xml</tt>
file before being passed to Checkstyle as a configuration.</p>
+
<p>There are 4 predefined rulesets.</p>
-<ul><li><code>config/sun_checks.xml</code>: Sun Checks.</li>
-<li><code>config/turbine_checks.xml</code>: Turbine Checks.</li>
-<li><code>config/avalon_checks.xml</code>: Avalon Checks.</li>
-<li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
-</ul>
-<br />
-<strong>Default value is</strong>: <code>config/sun_checks.xml</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#consoleOutput">consoleOutput</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>-</code></td>
-<td>Output errors to console.<br />
-<strong>Default value is</strong>: <code>false</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#enableFilesSummary">enableFilesSummary</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>-</code></td>
-<td>Specifies if the Files summary should be enabled or not.<br />
-<strong>Default value is</strong>: <code>true</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#enableRSS">enableRSS</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>-</code></td>
-<td>Specifies if the RSS should be enabled or not.<br />
-<strong>Default value is</strong>: <code>true</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#enableRulesSummary">enableRulesSummary</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>-</code></td>
-<td>Specifies if the Rules summary should be enabled or not.<br />
-<strong>Default value is</strong>: <code>true</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#enableSeveritySummary">enableSeveritySummary</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>-</code></td>
-<td>Specifies if the Severity summary should be enabled or not.<br />
-<strong>Default value is</strong>: <code>true</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#encoding">encoding</a></strong></td>
-<td><code>String</code></td>
-<td><code>2.2</code></td>
-<td>The file encoding to use when reading the source files. If the
-property <code>project.build.sourceEncoding</code> is not set, the
-platform default encoding is used. <strong>Note:</strong> This
-parameter always overrides the property <code>charset</code> from
-Checkstyle's <code>TreeWalker</code> module.<br />
-<strong>Default value is</strong>: <code>${project.build.sourceEncoding}</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#excludes">excludes</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td>Specifies the names filter of the source files to be excluded for
-Checkstyle.<br />
-</td>
-</tr>
-<tr class="a"><td><strong><a href="#failsOnError">failsOnError</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>-</code></td>
-<td>Specifies if the build should fail upon a violation.<br />
-<strong>Default value is</strong>: <code>false</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#format">format</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td><strong>Deprecated.</strong> Use configLocation instead.<br />
-<strong>Default value is</strong>: <code>sun</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#headerFile">headerFile</a></strong></td>
-<td><code>File</code></td>
-<td><code>-</code></td>
-<td><strong>Deprecated.</strong> Use headerLocation instead.<br />
-</td>
-</tr>
-<tr class="b"><td><strong><a href="#headerLocation">headerLocation</a></strong></td>
-<td><code>String</code></td>
-<td><code>2.0-beta-2</code></td>
-<td><p>Specifies the location of the License file (a.k.a. the header
+
+<ul>
+<li><tt>config/sun_checks.xml</tt>: Sun Checks.</li>
+
+<li><tt>config/turbine_checks.xml</tt>: Turbine Checks.</li>
+
+<li><tt>config/avalon_checks.xml</tt>: Avalon Checks.</li>
+
+<li><tt>config/maven_checks.xml</tt>: Maven Source Checks.</li>
+</ul><br /><b>Default value is</b>: <tt>config/sun_checks.xml</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#consoleOutput">consoleOutput</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>-</tt></td>
+ <td>Output errors to console.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#enableFilesSummary">enableFilesSummary</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies if the Files summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#enableRSS">enableRSS</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies if the RSS should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#enableRulesSummary">enableRulesSummary</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies if the Rules summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#enableSeveritySummary">enableSeveritySummary</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies if the Severity summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#encoding">encoding</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.2</tt></td>
+ <td>The file encoding to use when reading the source files. If the
+property <tt>project.build.sourceEncoding</tt> is not set, the
+platform default encoding is used. <b>Note:</b> This
+parameter always overrides the property <tt>charset</tt> from
+Checkstyle's <tt>TreeWalker</tt> module.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#excludes">excludes</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies the names filter of the source files to be excluded for
+Checkstyle.<br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#failsOnError">failsOnError</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies if the build should fail upon a violation.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#format">format</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td><b>Deprecated.</b> Use configLocation instead.<br /><b>Default value is</b>: <tt>sun</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#headerFile">headerFile</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td><b>Deprecated.</b> Use headerLocation instead.<br /></td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#headerLocation">headerLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.0-beta-2</tt></td>
+ <td><p>Specifies the location of the License file (a.k.a. the header
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
+
<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
configuration to reference the name of this header file.</p>
+
<p>For instance:</p>
-<p><code><module name="RegexpHeader"> <property
+
+<p><tt><module name="RegexpHeader"> <property
name="headerFile" value="${checkstyle.header.file}"/>
-</module></code></p>
-<br />
-<strong>Default value is</strong>: <code>LICENSE.txt</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#includeTestSourceDirectory">includeTestSourceDirectory</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>2.2</code></td>
-<td>Include or not the test source directory to be used for Checkstyle.<br />
-<strong>Default value is</strong>: <code>${false}</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#linkXRef">linkXRef</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>2.1</code></td>
-<td>Link the violation line numbers to the source xref. Will link
-automatically if Maven JXR plugin is being used.<br />
-<strong>Default value is</strong>: <code>true</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#outputFile">outputFile</a></strong></td>
-<td><code>File</code></td>
-<td><code>-</code></td>
-<td>Specifies the path and filename to save the checkstyle output. The
+</module></tt></p><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#includeTestSourceDirectory">includeTestSourceDirectory</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.2</tt></td>
+ <td>Include or not the test source directory to be used for Checkstyle.<br /><b>Default value is</b>: <tt>${false}</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#linkXRef">linkXRef</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.1</tt></td>
+ <td>Link the violation line numbers to the source xref. Will link
+automatically if Maven JXR plugin is being used.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#outputFile">outputFile</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies the path and filename to save the checkstyle output. The
format of the output file is determined by the
-<code>outputFileFormat</code> parameter.<br />
-<strong>Default value is</strong>: <code>${project.build.directory}/checkstyle-result.xml</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#outputFileFormat">outputFileFormat</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td>Specifies the format of the output to be used when writing to the
-output file. Valid values are "plain" and "xml".<br />
-<strong>Default value is</strong>: <code>xml</code>.</td>
-</tr>
-<tr class="a"><td><strong><a href="#packageNamesFile">packageNamesFile</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td><strong>Deprecated.</strong> Use packageNamesLocation instead.<br />
-</td>
-</tr>
-<tr class="b"><td><strong><a href="#packageNamesLocation">packageNamesLocation</a></strong></td>
-<td><code>String</code></td>
-<td><code>2.0-beta-2</code></td>
-<td><p>Specifies the location of the package names XML to be used to
+<tt>outputFileFormat</tt> parameter.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#outputFileFormat">outputFileFormat</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td>Specifies the format of the output to be used when writing to the
+output file. Valid values are "plain" and "xml".<br /><b>Default value is</b>: <tt>xml</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#packageNamesFile">packageNamesFile</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td><b>Deprecated.</b> Use packageNamesLocation instead.<br /></td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#packageNamesLocation">packageNamesLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.0-beta-2</tt></td>
+ <td><p>Specifies the location of the package names XML to be used to
configure the Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Packages">Packages</a>.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
resolved to a resource, or a URL, the contents of the package names
XML is copied into the
-<code>${project.build.directory}/checkstyle-packagenames.xml</code>
-file before being passed to Checkstyle for loading.</p>
-<br />
-</td>
-</tr>
-<tr class="a"><td><strong><a href="#propertiesFile">propertiesFile</a></strong></td>
-<td><code>File</code></td>
-<td><code>-</code></td>
-<td><strong>Deprecated.</strong> Use propertiesLocation instead.<br />
-</td>
-</tr>
-<tr class="b"><td><strong><a href="#propertiesLocation">propertiesLocation</a></strong></td>
-<td><code>String</code></td>
-<td><code>2.0-beta-2</code></td>
-<td><p>Specifies the location of the properties file.</p>
+<tt>${project.build.directory}/checkstyle-packagenames.xml</tt>
+file before being passed to Checkstyle for loading.</p><br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#propertiesFile">propertiesFile</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td><b>Deprecated.</b> Use propertiesLocation instead.<br /></td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#propertiesLocation">propertiesLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.0-beta-2</tt></td>
+ <td><p>Specifies the location of the properties file.</p>
+
<p>This parameter is resolved as URL, File then resource. If
successfully resolved, the contents of the properties location is
copied into the
-<code>${project.build.directory}/checkstyle-checker.properties</code>
+<tt>${project.build.directory}/checkstyle-checker.properties</tt>
file before being passed to Checkstyle for loading.</p>
-<p>The contents of the <code>propertiesLocation</code> will be made
+
+<p>The contents of the <tt>propertiesLocation</tt> will be made
available to Checkstyle for specifying values for parameters within
-the xml configuration (specified in the <code>configLocation</code>
-parameter).</p>
-<br />
-</td>
-</tr>
-<tr class="a"><td><strong><a href="#propertiesURL">propertiesURL</a></strong></td>
-<td><code>URL</code></td>
-<td><code>-</code></td>
-<td><strong>Deprecated.</strong> Use propertiesLocation instead.<br />
-</td>
-</tr>
-<tr class="b"><td><strong><a href="#propertyExpansion">propertyExpansion</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td>Allows for specifying raw property expansion information.<br />
-</td>
-</tr>
-<tr class="a"><td><strong><a href="#skip">skip</a></strong></td>
-<td><code>boolean</code></td>
-<td><code>2.2</code></td>
-<td>Skip entire check.<br />
-<strong>Default value is</strong>: <code>false</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#suppressionsFile">suppressionsFile</a></strong></td>
-<td><code>String</code></td>
-<td><code>-</code></td>
-<td><strong>Deprecated.</strong> Use suppressionsLocation instead.<br />
-</td>
-</tr>
-<tr class="a"><td><strong><a href="#suppressionsFileExpression">suppressionsFileExpression</a></strong></td>
-<td><code>String</code></td>
-<td><code>2.1</code></td>
-<td>The key to be used in the properties for the suppressions file.<br />
-<strong>Default value is</strong>: <code>checkstyle.suppressions.file</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#suppressionsLocation">suppressionsLocation</a></strong></td>
-<td><code>String</code></td>
-<td><code>2.0-beta-2</code></td>
-<td><p>Specifies the location of the suppressions XML file to use.</p>
+the xml configuration (specified in the <tt>configLocation</tt>
+parameter).</p><br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#propertiesURL">propertiesURL</a></b></td>
+ <td><tt>URL</tt></td>
+ <td><tt>-</tt></td>
+ <td><b>Deprecated.</b> Use propertiesLocation instead.<br /></td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#propertyExpansion">propertyExpansion</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td>Allows for specifying raw property expansion information.<br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#skip">skip</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.2</tt></td>
+ <td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#suppressionsFile">suppressionsFile</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>-</tt></td>
+ <td><b>Deprecated.</b> Use suppressionsLocation instead.<br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#suppressionsFileExpression">suppressionsFileExpression</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.1</tt></td>
+ <td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <tt>checkstyle.suppressions.file</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#suppressionsLocation">suppressionsLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.0-beta-2</tt></td>
+ <td><p>Specifies the location of the suppressions XML file to use.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the suppressions XML is
copied into the
-<code>${project.build.directory}/checkstyle-supressions.xml</code>
+<tt>${project.build.directory}/checkstyle-supressions.xml</tt>
file before being passed to Checkstyle for loading.</p>
-<p>See <code>suppressionsFileExpression</code> for the property
-that will be made available to your checkstyle configuration.</p>
-<br />
-</td>
-</tr>
-<tr class="a"><td><strong><a href="#testSourceDirectory">testSourceDirectory</a></strong></td>
-<td><code>File</code></td>
-<td><code>2.2</code></td>
-<td>Specifies the location of the test source directory to be used for
-Checkstyle.<br />
-<strong>Default value is</strong>: <code>${project.build.testSourceDirectory}</code>.</td>
-</tr>
-<tr class="b"><td><strong><a href="#useFile">useFile</a></strong></td>
-<td><code>File</code></td>
-<td><code>-</code></td>
-<td>If <code>null</code>, the Checkstyle plugin will display violations
+
+<p>See <tt>suppressionsFileExpression</tt> for the property
+that will be made available to your checkstyle configuration.</p><br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#testSourceDirectory">testSourceDirectory</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>2.2</tt></td>
+ <td>Specifies the location of the test source directory to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>${project.build.testSourceDirectory}</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#useFile">useFile</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td>If <tt>null</tt>, the Checkstyle plugin will display violations
on stdout. Otherwise, a text file will be created with the
-violations.<br />
-</td>
-</tr>
-<tr class="a"><td><strong><a href="#xrefLocation">xrefLocation</a></strong></td>
-<td><code>File</code></td>
-<td><code>-</code></td>
-<td>Location of the Xrefs to link to.<br />
-<strong>Default value is</strong>: <code>${project.reporting.outputDirectory}/xref</code>.</td>
-</tr>
-</table>
-</div>
-<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
-<p><strong><a name="cacheFile">cacheFile</a>:</strong></p>
-<div>Specifies the cache file used to speed up Checkstyle on successive
-runs.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Default</strong>: <code>${project.build.directory}/checkstyle-cachefile</code></li>
-</ul>
-<hr />
-<p><strong><a name="configLocation">configLocation</a>:</strong></p>
-<div><p>Specifies the location of the XML configuration to use.</p>
+violations.<br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#xrefLocation">xrefLocation</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>-</tt></td>
+ <td>Location of the Xrefs to link to.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}/xref</tt>.</td>
+ </tr>
+ </table>
+ </div>
+ <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
+ <p><b><a name="cacheFile">cacheFile</a>:</b></p>
+ <div>Specifies the cache file used to speed up Checkstyle on successive
+runs.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${project.build.directory}/checkstyle-cachefile</tt></li>
+ </ul><hr /><p><b><a name="configLocation">configLocation</a>:</b></p>
+ <div><p>Specifies the location of the XML configuration to use.</p>
+
<p>Potential values are a filesystem path, a URL, or a classpath
resource. This parameter expects that the contents of the location
conform to the xml format (Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Modules">Checker
module</a>) configuration of rulesets.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the configuration is copied
into the
-<code>${project.build.directory}/checkstyle-configuration.xml</code>
+<tt>${project.build.directory}/checkstyle-configuration.xml</tt>
file before being passed to Checkstyle as a configuration.</p>
+
<p>There are 4 predefined rulesets.</p>
-<ul><li><code>config/sun_checks.xml</code>: Sun Checks.</li>
-<li><code>config/turbine_checks.xml</code>: Turbine Checks.</li>
-<li><code>config/avalon_checks.xml</code>: Avalon Checks.</li>
-<li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
-</ul>
-</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.config.location}</code></li>
-<li><strong>Default</strong>: <code>config/sun_checks.xml</code></li>
-</ul>
-<hr />
-<p><strong><a name="consoleOutput">consoleOutput</a>:</strong></p>
-<div>Output errors to console.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Default</strong>: <code>false</code></li>
-</ul>
-<hr />
-<p><strong><a name="enableFilesSummary">enableFilesSummary</a>:</strong></p>
-<div>Specifies if the Files summary should be enabled or not.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.enable.files.summary}</code></li>
-<li><strong>Default</strong>: <code>true</code></li>
-</ul>
-<hr />
-<p><strong><a name="enableRSS">enableRSS</a>:</strong></p>
-<div>Specifies if the RSS should be enabled or not.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.enable.rss}</code></li>
-<li><strong>Default</strong>: <code>true</code></li>
-</ul>
-<hr />
-<p><strong><a name="enableRulesSummary">enableRulesSummary</a>:</strong></p>
-<div>Specifies if the Rules summary should be enabled or not.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.enable.rules.summary}</code></li>
-<li><strong>Default</strong>: <code>true</code></li>
-</ul>
-<hr />
-<p><strong><a name="enableSeveritySummary">enableSeveritySummary</a>:</strong></p>
-<div>Specifies if the Severity summary should be enabled or not.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.enable.severity.summary}</code></li>
-<li><strong>Default</strong>: <code>true</code></li>
-</ul>
-<hr />
-<p><strong><a name="encoding">encoding</a>:</strong></p>
-<div>The file encoding to use when reading the source files. If the
-property <code>project.build.sourceEncoding</code> is not set, the
-platform default encoding is used. <strong>Note:</strong> This
-parameter always overrides the property <code>charset</code> from
-Checkstyle's <code>TreeWalker</code> module.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Since</strong>: <code>2.2</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${encoding}</code></li>
-<li><strong>Default</strong>: <code>${project.build.sourceEncoding}</code></li>
-</ul>
-<hr />
-<p><strong><a name="excludes">excludes</a>:</strong></p>
-<div>Specifies the names filter of the source files to be excluded for
-Checkstyle.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.excludes}</code></li>
-</ul>
-<hr />
-<p><strong><a name="failsOnError">failsOnError</a>:</strong></p>
-<div>Specifies if the build should fail upon a violation.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Default</strong>: <code>false</code></li>
-</ul>
-<hr />
-<p><strong><a name="format">format</a>:</strong></p>
-<div><strong>Deprecated.</strong> Use configLocation instead.</div><div>Specifies what predefined check set to use. Available sets are
-"sun" (for the Sun coding conventions), "turbine", and "avalon".</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Default</strong>: <code>sun</code></li>
-</ul>
-<hr />
-<p><strong><a name="headerFile">headerFile</a>:</strong></p>
-<div><strong>Deprecated.</strong> Use headerLocation instead.</div><div>Specifies the location of the License file (a.k.a. the header file)
+
+<ul>
+<li><tt>config/sun_checks.xml</tt>: Sun Checks.</li>
+
+<li><tt>config/turbine_checks.xml</tt>: Turbine Checks.</li>
+
+<li><tt>config/avalon_checks.xml</tt>: Avalon Checks.</li>
+
+<li><tt>config/maven_checks.xml</tt>: Maven Source Checks.</li>
+</ul></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.config.location}</tt></li>
+ <li><b>Default</b>: <tt>config/sun_checks.xml</tt></li>
+ </ul><hr /><p><b><a name="consoleOutput">consoleOutput</a>:</b></p>
+ <div>Output errors to console.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="enableFilesSummary">enableFilesSummary</a>:</b></p>
+ <div>Specifies if the Files summary should be enabled or not.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.enable.files.summary}</tt></li>
+ <li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="enableRSS">enableRSS</a>:</b></p>
+ <div>Specifies if the RSS should be enabled or not.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.enable.rss}</tt></li>
+ <li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="enableRulesSummary">enableRulesSummary</a>:</b></p>
+ <div>Specifies if the Rules summary should be enabled or not.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.enable.rules.summary}</tt></li>
+ <li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="enableSeveritySummary">enableSeveritySummary</a>:</b></p>
+ <div>Specifies if the Severity summary should be enabled or not.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.enable.severity.summary}</tt></li>
+ <li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="encoding">encoding</a>:</b></p>
+ <div>The file encoding to use when reading the source files. If the
+property <tt>project.build.sourceEncoding</tt> is not set, the
+platform default encoding is used. <b>Note:</b> This
+parameter always overrides the property <tt>charset</tt> from
+Checkstyle's <tt>TreeWalker</tt> module.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${encoding}</tt></li>
+ <li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
+ </ul><hr /><p><b><a name="excludes">excludes</a>:</b></p>
+ <div>Specifies the names filter of the source files to be excluded for
+Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.excludes}</tt></li>
+ </ul><hr /><p><b><a name="failsOnError">failsOnError</a>:</b></p>
+ <div>Specifies if the build should fail upon a violation.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="format">format</a>:</b></p>
+ <div><b>Deprecated.</b> Use configLocation instead.</div>
+ <div>Specifies what predefined check set to use. Available sets are
+"sun" (for the Sun coding conventions), "turbine", and "avalon".</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>sun</tt></li>
+ </ul><hr /><p><b><a name="headerFile">headerFile</a>:</b></p>
+ <div><b>Deprecated.</b> Use headerLocation instead.</div>
+ <div>Specifies the location of the License file (a.k.a. the header file)
that is used by Checkstyle to verify that source code has the
-correct license header.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${basedir}/LICENSE.txt</code></li>
-</ul>
-<hr />
-<p><strong><a name="headerLocation">headerLocation</a>:</strong></p>
-<div><p>Specifies the location of the License file (a.k.a. the header
+correct license header.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${basedir}/LICENSE.txt</tt></li>
+ </ul><hr /><p><b><a name="headerLocation">headerLocation</a>:</b></p>
+ <div><p>Specifies the location of the License file (a.k.a. the header
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
+
<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
configuration to reference the name of this header file.</p>
+
<p>For instance:</p>
-<p><code><module name="RegexpHeader"> <property
+
+<p><tt><module name="RegexpHeader"> <property
name="headerFile" value="${checkstyle.header.file}"/>
-</module></code></p>
-</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Since</strong>: <code>2.0-beta-2</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.header.file}</code></li>
-<li><strong>Default</strong>: <code>LICENSE.txt</code></li>
-</ul>
-<hr />
-<p><strong><a name="includeTestSourceDirectory">includeTestSourceDirectory</a>:</strong></p>
-<div>Include or not the test source directory to be used for Checkstyle.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Since</strong>: <code>2.2</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Default</strong>: <code>${false}</code></li>
-</ul>
-<hr />
-<p><strong><a name="includes">includes</a>:</strong></p>
-<div>Specifies the names filter of the source files to be used for
-Checkstyle.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>Yes</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.includes}</code></li>
-<li><strong>Default</strong>: <code>**/*.java</code></li>
-</ul>
-<hr />
-<p><strong><a name="linkXRef">linkXRef</a>:</strong></p>
-<div>Link the violation line numbers to the source xref. Will link
-automatically if Maven JXR plugin is being used.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Since</strong>: <code>2.1</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${linkXRef}</code></li>
-<li><strong>Default</strong>: <code>true</code></li>
-</ul>
-<hr />
-<p><strong><a name="outputDirectory">outputDirectory</a>:</strong></p>
-<div>The output directory for the report. Note that this parameter is
+</module></tt></p></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.header.file}</tt></li>
+ <li><b>Default</b>: <tt>LICENSE.txt</tt></li>
+ </ul><hr /><p><b><a name="includeTestSourceDirectory">includeTestSourceDirectory</a>:</b></p>
+ <div>Include or not the test source directory to be used for Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${false}</tt></li>
+ </ul><hr /><p><b><a name="includes">includes</a>:</b></p>
+ <div>Specifies the names filter of the source files to be used for
+Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>Yes</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.includes}</tt></li>
+ <li><b>Default</b>: <tt>**/*.java</tt></li>
+ </ul><hr /><p><b><a name="linkXRef">linkXRef</a>:</b></p>
+ <div>Link the violation line numbers to the source xref. Will link
+automatically if Maven JXR plugin is being used.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.1</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${linkXRef}</tt></li>
+ <li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
+ <div>The output directory for the report. Note that this parameter is
only evaluated if the goal is run directly from the command line.
If the goal is run indirectly as part of a site generation, the
-output directory configured in Maven Site Plugin is used instead.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
-<li><strong>Required</strong>: <code>Yes</code></li>
-<li><strong>Default</strong>: <code>${project.reporting.outputDirectory}</code></li>
-</ul>
-<hr />
-<p><strong><a name="outputFile">outputFile</a>:</strong></p>
-<div>Specifies the path and filename to save the checkstyle output. The
+output directory configured in Maven Site Plugin is used instead.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Required</b>: <tt>Yes</tt></li>
+ <li><b>Default</b>: <tt>${project.reporting.outputDirectory}</tt></li>
+ </ul><hr /><p><b><a name="outputFile">outputFile</a>:</b></p>
+ <div>Specifies the path and filename to save the checkstyle output. The
format of the output file is determined by the
-<code>outputFileFormat</code> parameter.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.output.file}</code></li>
-<li><strong>Default</strong>: <code>${project.build.directory}/checkstyle-result.xml</code></li>
-</ul>
-<hr />
-<p><strong><a name="outputFileFormat">outputFileFormat</a>:</strong></p>
-<div>Specifies the format of the output to be used when writing to the
-output file. Valid values are "plain" and "xml".</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.output.format}</code></li>
-<li><strong>Default</strong>: <code>xml</code></li>
-</ul>
-<hr />
-<p><strong><a name="packageNamesFile">packageNamesFile</a>:</strong></p>
-<div><strong>Deprecated.</strong> Use packageNamesLocation instead.</div><div>Specifies the location of the package names XML to be used to
-configure Checkstyle.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-</ul>
-<hr />
-<p><strong><a name="packageNamesLocation">packageNamesLocation</a>:</strong></p>
-<div><p>Specifies the location of the package names XML to be used to
+<tt>outputFileFormat</tt> parameter.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.output.file}</tt></li>
+ <li><b>Default</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt></li>
+ </ul><hr /><p><b><a name="outputFileFormat">outputFileFormat</a>:</b></p>
+ <div>Specifies the format of the output to be used when writing to the
+output file. Valid values are "plain" and "xml".</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.output.format}</tt></li>
+ <li><b>Default</b>: <tt>xml</tt></li>
+ </ul><hr /><p><b><a name="packageNamesFile">packageNamesFile</a>:</b></p>
+ <div><b>Deprecated.</b> Use packageNamesLocation instead.</div>
+ <div>Specifies the location of the package names XML to be used to
+configure Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /><p><b><a name="packageNamesLocation">packageNamesLocation</a>:</b></p>
+ <div><p>Specifies the location of the package names XML to be used to
configure the Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Packages">Packages</a>.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
resolved to a resource, or a URL, the contents of the package names
XML is copied into the
-<code>${project.build.directory}/checkstyle-packagenames.xml</code>
-file before being passed to Checkstyle for loading.</p>
-</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Since</strong>: <code>2.0-beta-2</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-</ul>
-<hr />
-<p><strong><a name="propertiesFile">propertiesFile</a>:</strong></p>
-<div><strong>Deprecated.</strong> Use propertiesLocation instead.</div><div>Specifies the location of the Checkstyle properties file that will
-be used to check the source.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-</ul>
-<hr />
-<p><strong><a name="propertiesLocation">propertiesLocation</a>:</strong></p>
-<div><p>Specifies the location of the properties file.</p>
+<tt>${project.build.directory}/checkstyle-packagenames.xml</tt>
+file before being passed to Checkstyle for loading.</p></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /><p><b><a name="propertiesFile">propertiesFile</a>:</b></p>
+ <div><b>Deprecated.</b> Use propertiesLocation instead.</div>
+ <div>Specifies the location of the Checkstyle properties file that will
+be used to check the source.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /><p><b><a name="propertiesLocation">propertiesLocation</a>:</b></p>
+ <div><p>Specifies the location of the properties file.</p>
+
<p>This parameter is resolved as URL, File then resource. If
successfully resolved, the contents of the properties location is
copied into the
-<code>${project.build.directory}/checkstyle-checker.properties</code>
+<tt>${project.build.directory}/checkstyle-checker.properties</tt>
file before being passed to Checkstyle for loading.</p>
-<p>The contents of the <code>propertiesLocation</code> will be made
+
+<p>The contents of the <tt>propertiesLocation</tt> will be made
available to Checkstyle for specifying values for parameters within
-the xml configuration (specified in the <code>configLocation</code>
-parameter).</p>
-</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Since</strong>: <code>2.0-beta-2</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.properties.location}</code></li>
-</ul>
-<hr />
-<p><strong><a name="propertiesURL">propertiesURL</a>:</strong></p>
-<div><strong>Deprecated.</strong> Use propertiesLocation instead.</div><div>Specifies the URL of the Checkstyle properties that will be used to
-check the source.</div><ul><li><strong>Type</strong>: <code>java.net.URL</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-</ul>
-<hr />
-<p><strong><a name="propertyExpansion">propertyExpansion</a>:</strong></p>
-<div>Allows for specifying raw property expansion information.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-</ul>
-<hr />
-<p><strong><a name="skip">skip</a>:</strong></p>
-<div>Skip entire check.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
-<li><strong>Since</strong>: <code>2.2</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.skip}</code></li>
-<li><strong>Default</strong>: <code>false</code></li>
-</ul>
-<hr />
-<p><strong><a name="sourceDirectory">sourceDirectory</a>:</strong></p>
-<div>Specifies the location of the source directory to be used for
-Checkstyle.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
-<li><strong>Required</strong>: <code>Yes</code></li>
-<li><strong>Default</strong>: <code>${project.build.sourceDirectory}</code></li>
-</ul>
-<hr />
-<p><strong><a name="suppressionsFile">suppressionsFile</a>:</strong></p>
-<div><strong>Deprecated.</strong> Use suppressionsLocation instead.</div><div>Specifies the location of the suppressions XML file to use. The
+the xml configuration (specified in the <tt>configLocation</tt>
+parameter).</p></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.properties.location}</tt></li>
+ </ul><hr /><p><b><a name="propertiesURL">propertiesURL</a>:</b></p>
+ <div><b>Deprecated.</b> Use propertiesLocation instead.</div>
+ <div>Specifies the URL of the Checkstyle properties that will be used to
+check the source.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.net.URL</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /><p><b><a name="propertyExpansion">propertyExpansion</a>:</b></p>
+ <div>Allows for specifying raw property expansion information.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /><p><b><a name="skip">skip</a>:</b></p>
+ <div>Skip entire check.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.skip}</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
+ <div>Specifies the location of the source directory to be used for
+Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Required</b>: <tt>Yes</tt></li>
+ <li><b>Default</b>: <tt>${project.build.sourceDirectory}</tt></li>
+ </ul><hr /><p><b><a name="suppressionsFile">suppressionsFile</a>:</b></p>
+ <div><b>Deprecated.</b> Use suppressionsLocation instead.</div>
+ <div>Specifies the location of the suppressions XML file to use. The
plugin defines a Checkstyle property named
-<code>checkstyle.suppressions.file</code> with the value of this
+<tt>checkstyle.suppressions.file</tt> with the value of this
property. This allows using the Checkstyle property in your own
custom checkstyle configuration file when specifying a suppressions
-file.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-</ul>
-<hr />
-<p><strong><a name="suppressionsFileExpression">suppressionsFileExpression</a>:</strong></p>
-<div>The key to be used in the properties for the suppressions file.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Since</strong>: <code>2.1</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.suppression.expression}</code></li>
-<li><strong>Default</strong>: <code>checkstyle.suppressions.file</code></li>
-</ul>
-<hr />
-<p><strong><a name="suppressionsLocation">suppressionsLocation</a>:</strong></p>
-<div><p>Specifies the location of the suppressions XML file to use.</p>
+file.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /><p><b><a name="suppressionsFileExpression">suppressionsFileExpression</a>:</b></p>
+ <div>The key to be used in the properties for the suppressions file.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.1</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.suppression.expression}</tt></li>
+ <li><b>Default</b>: <tt>checkstyle.suppressions.file</tt></li>
+ </ul><hr /><p><b><a name="suppressionsLocation">suppressionsLocation</a>:</b></p>
+ <div><p>Specifies the location of the suppressions XML file to use.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the suppressions XML is
copied into the
-<code>${project.build.directory}/checkstyle-supressions.xml</code>
+<tt>${project.build.directory}/checkstyle-supressions.xml</tt>
file before being passed to Checkstyle for loading.</p>
-<p>See <code>suppressionsFileExpression</code> for the property
-that will be made available to your checkstyle configuration.</p>
-</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
-<li><strong>Since</strong>: <code>2.0-beta-2</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Expression</strong>: <code>${checkstyle.suppressions.location}</code></li>
-</ul>
-<hr />
-<p><strong><a name="testSourceDirectory">testSourceDirectory</a>:</strong></p>
-<div>Specifies the location of the test source directory to be used for
-Checkstyle.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
-<li><strong>Since</strong>: <code>2.2</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Default</strong>: <code>${project.build.testSourceDirectory}</code></li>
-</ul>
-<hr />
-<p><strong><a name="useFile">useFile</a>:</strong></p>
-<div>If <code>null</code>, the Checkstyle plugin will display violations
+
+<p>See <tt>suppressionsFileExpression</tt> for the property
+that will be made available to your checkstyle configuration.</p></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.suppressions.location}</tt></li>
+ </ul><hr /><p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
+ <div>Specifies the location of the test source directory to be used for
+Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Since</b>: <tt>2.2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${project.build.testSourceDirectory}</tt></li>
+ </ul><hr /><p><b><a name="useFile">useFile</a>:</b></p>
+ <div>If <tt>null</tt>, the Checkstyle plugin will display violations
on stdout. Otherwise, a text file will be created with the
-violations.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-</ul>
-<hr />
-<p><strong><a name="xrefLocation">xrefLocation</a>:</strong></p>
-<div>Location of the Xrefs to link to.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
-<li><strong>Required</strong>: <code>No</code></li>
-<li><strong>Default</strong>: <code>${project.reporting.outputDirectory}/xref</code></li>
-</ul>
-</div>
-</div>
+violations.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /><p><b><a name="xrefLocation">xrefLocation</a>:</b></p>
+ <div>Location of the Xrefs to link to.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${project.reporting.outputDirectory}/xref</tt></li>
+ </ul>
+ </div>
+ </div>
+
</div>
</div>