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:52:36 UTC
svn commit: r816652 [3/21] - 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/ cobertura/ css/
examples/ image...
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/check-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/check-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/check-mojo.html Tue May 8 13:52:31 2012
@@ -12,14 +12,14 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Checkstyle Plugin - maven-checkstyle-plugin - checkstyle:check</title>
+ <title>Maven Checkstyle Plugin - checkstyle:check</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 http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -52,27 +52,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -80,7 +72,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -159,6 +153,10 @@
+
+
+
+
<li class="collapsed">
<a href="project-info.html">Project Information</a>
@@ -192,6 +190,53 @@
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <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">
<img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
</a>
@@ -207,111 +252,127 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2><a name="checkstyle:check"></a>
-checkstyle:check</h2>
+ <div class="section"><h2><a name="checkstyle:check"></a>checkstyle:check</h2>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.2:check</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.3:check</p>
<p><strong>Description</strong>:</p>
-<p>Perform a violation check against the last Checkstyle run to see if
+<div>Perform a violation check against the last Checkstyle run to see if
there are any violations. It reads the Checkstyle output file,
counts the number of violations found and displays it on the
-console.</p>
-<p><strong>Attributes</strong>:</p>
+console.</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>
<li>Binds by default to the lifecycle phase: <code>verify</code>.</li>
-<li>Invokes the execution of this plugin's goal <code>checkstyle</code> prior to executing itself.</li>
+<li>Invokes the execution of this plugins goal <code>{0}</code> prior to executing itself.</li>
</ul>
-<div class="section"><h3><a name="Optional_Parameters"></a>
-Optional Parameters</h3>
+<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="#failOnViolation">failOnViolation</a>
-</strong></td>
+<tr class="b"><td><strong><a href="#failOnViolation">failOnViolation</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
-<td>Do we fail the build on a violation? Default value is: <code>true</code>.</td>
+<td>Do we fail the build on a violation?<br />
+<strong>Default value is</strong>: <code>true</code>.</td>
</tr>
-<tr class="a"><td><strong><a href="#outputFile">outputFile</a>
-</strong></td>
+<tr class="a"><td><strong><a href="#logViolationsToConsole">logViolationsToConsole</a></strong></td>
+<td><code>boolean</code></td>
+<td><code>2.3</code></td>
+<td>Output the detected violations to the console.<br />
+<strong>Default value is</strong>: <code>false</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#maxAllowedViolations">maxAllowedViolations</a></strong></td>
+<td><code>int</code></td>
+<td><code>2.3</code></td>
+<td>The maximum number of allowed violations. The execution fails only
+if the number of violations is above this limit.<br />
+<strong>Default value is</strong>: <code>0</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
format of the output file is determined by the
-<code>outputFileFormat</code> parameter. Default value is: <code>${project.build.directory}/checkstyle-result.xml</code>.</td>
+<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>
+<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". Default value is: <code>xml</code>.</td>
+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="#skip">skip</a>
-</strong></td>
+<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. Default value is: <code>false</code>.</td>
+<td>Skip entire check.<br />
+<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
-<tr class="b"><td><strong><a href="#violationSeverity">violationSeverity</a>
-</strong></td>
+<tr class="b"><td><strong><a href="#violationSeverity">violationSeverity</a></strong></td>
<td><code>String</code></td>
<td><code>2.2</code></td>
<td>The lowest severity level that is considered a violation. Valid
-values are "error", "warning" and "info". Default value is: <code>error</code>.</td>
+values are "error", "warning" and "info".<br />
+<strong>Default value is</strong>: <code>error</code>.</td>
</tr>
</table>
</div>
-<div class="section"><h3><a name="Parameter_Details"></a>
-Parameter Details</h3>
-<p><strong><a name="failOnViolation">failOnViolation</a>
-:</strong></p>
-<p>Do we fail the build on a violation?</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
+<p><strong><a name="failOnViolation">failOnViolation</a>:</strong></p>
+<div>Do we fail the build on a violation?</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${checkstyle.failOnViolation}</code></li>
<li><strong>Default</strong>: <code>true</code></li>
</ul>
<hr />
-<p><strong><a name="outputFile">outputFile</a>
-:</strong></p>
-<p>Specifies the path and filename to save the Checkstyle output. The
+<p><strong><a name="logViolationsToConsole">logViolationsToConsole</a>:</strong></p>
+<div>Output the detected violations to the console.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Since</strong>: <code>2.3</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.console}</code></li>
+<li><strong>Default</strong>: <code>false</code></li>
+</ul>
+<hr />
+<p><strong><a name="maxAllowedViolations">maxAllowedViolations</a>:</strong></p>
+<div>The maximum number of allowed violations. The execution fails only
+if the number of violations is above this limit.</div><ul><li><strong>Type</strong>: <code>int</code></li>
+<li><strong>Since</strong>: <code>2.3</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.maxAllowedViolations}</code></li>
+<li><strong>Default</strong>: <code>0</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
format of the output file is determined by the
-<code>outputFileFormat</code> parameter.</p>
-<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<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>
-<p>Specifies the format of the output to be used when writing to the
-output file. Valid values are "plain" and "xml".</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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="skip">skip</a>
-:</strong></p>
-<p>Skip entire check.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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="violationSeverity">violationSeverity</a>
-:</strong></p>
-<p>The lowest severity level that is considered a violation. Valid
-values are "error", "warning" and "info".</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<p><strong><a name="violationSeverity">violationSeverity</a>:</strong></p>
+<div>The lowest severity level that is considered a violation. Valid
+values are "error", "warning" and "info".</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>${checkstyle.violationSeverity}</code></li>
@@ -327,7 +388,7 @@ values are "error", "warn
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -338,7 +399,7 @@ values are "error", "warn
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
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:52:31 2012
@@ -12,14 +12,14 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Checkstyle Plugin - 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");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -52,27 +52,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -80,7 +72,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -159,6 +153,10 @@
+
+
+
+
<li class="collapsed">
<a href="project-info.html">Project Information</a>
@@ -192,6 +190,53 @@
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <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">
<img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
</a>
@@ -207,73 +252,67 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2><a name="checkstyle:checkstyle"></a>
-checkstyle:checkstyle</h2>
-<p><strong>Note</strong>: This Mojo should be used as a Maven report.</p>
+ <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.2:checkstyle</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.3:checkstyle</p>
<p><strong>Description</strong>:</p>
-<p>Perform a Checkstyle analysis, and generate a report on violations.</p>
-<p><strong>Attributes</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>
+<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>
+<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. Default value is: <code>**/*.java</code>.</td>
+Checkstyle.<br />
+<strong>Default value is</strong>: <code>**/*.java</code>.</td>
</tr>
-<tr class="a"><td><strong><a href="#outputDirectory">outputDirectory</a>
-</strong></td>
+<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
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. Default value is: <code>${project.reporting.outputDirectory}</code>.</td>
+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>
+<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. Default value is: <code>${project.build.sourceDirectory}</code>.</td>
+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>
+<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>
+<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. Default value is: <code>${project.build.directory}/checkstyle-cachefile</code>.</td>
+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>
+<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>
<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 href="http://checkstyle.sourceforge.net/config.html#Modules" class="externalLink">Checker
-module</a>
-) configuration of rulesets.</p>
+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
@@ -285,78 +324,75 @@ file before being passed to Checkstyle a
<li><code>config/avalon_checks.xml</code>: Avalon Checks.</li>
<li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
</ul>
- Default value is: <code>config/sun_checks.xml</code>.</td>
+<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>
+<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. Default value is: <code>false</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>
+<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. Default value is: <code>true</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>
+<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. Default value is: <code>true</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>
+<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. Default value is: <code>true</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>
+<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. Default value is: <code>true</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>
+<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. Default value is: <code>${project.build.sourceEncoding}</code>.</td>
+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>
+<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. </td>
+Checkstyle.<br />
+</td>
</tr>
-<tr class="a"><td><strong><a href="#failsOnError">failsOnError</a>
-</strong></td>
+<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. Default value is: <code>false</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>
+<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>. Specifies what predefined check set to use. Available sets are
-"sun" (for the Sun coding conventions), "turbine", and "avalon". Default value is: <code>sun</code>.</td>
+<td><strong><strong>Deprecated</strong>. {0}.</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>
+<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>. 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. </td>
+<td><strong><strong>Deprecated</strong>. {0}.</strong> Use headerLocation instead.<br />
+</td>
</tr>
-<tr class="b"><td><strong><a href="#headerLocation">headerLocation</a>
-</strong></td>
+<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
@@ -368,66 +404,63 @@ configuration to reference the name of t
<p><code><module name="RegexpHeader"> <property
name="headerFile" value="${checkstyle.header.file}"/>
</module></code></p>
- Default value is: <code>LICENSE.txt</code>.</td>
+<br />
+<strong>Default value is</strong>: <code>LICENSE.txt</code>.</td>
</tr>
-<tr class="a"><td><strong><a href="#includeTestSourceDirectory">includeTestSourceDirectory</a>
-</strong></td>
+<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. Default value is: <code>${false}</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>
+<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. Default value is: <code>true</code>.</td>
+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>
+<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
format of the output file is determined by the
-<code>outputFileFormat</code> parameter. Default value is: <code>${project.build.directory}/checkstyle-result.xml</code>.</td>
+<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>
+<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". Default value is: <code>xml</code>.</td>
+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>
+<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>. Specifies the location of the package names XML to be used to
-configure Checkstyle. </td>
+<td><strong><strong>Deprecated</strong>. {0}.</strong> Use packageNamesLocation instead.<br />
+</td>
</tr>
-<tr class="b"><td><strong><a href="#packageNamesLocation">packageNamesLocation</a>
-</strong></td>
+<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
-configure the Checkstyle <a href="http://checkstyle.sourceforge.net/config.html#Packages" class="externalLink">Packages</a>
-.</p>
+configure the Checkstyle <a href="http://checkstyle.sourceforge.net/config.html#Packages" class="externalLink">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>
+<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>. Specifies the location of the Checkstyle properties file that will
-be used to check the source. </td>
+<td><strong><strong>Deprecated</strong>. {0}.</strong> Use propertiesLocation instead.<br />
+</td>
</tr>
-<tr class="b"><td><strong><a href="#propertiesLocation">propertiesLocation</a>
-</strong></td>
+<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>
@@ -440,46 +473,40 @@ file before being passed to Checkstyle f
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>
+<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>. Specifies the URL of the Checkstyle properties that will be used to
-check the source. </td>
+<td><strong><strong>Deprecated</strong>. {0}.</strong> Use propertiesLocation instead.<br />
+</td>
</tr>
-<tr class="b"><td><strong><a href="#propertyExpansion">propertyExpansion</a>
-</strong></td>
+<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. </td>
+<td>Allows for specifying raw property expansion information.<br />
+</td>
</tr>
-<tr class="a"><td><strong><a href="#skip">skip</a>
-</strong></td>
+<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. Default value is: <code>false</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>
+<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>. 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
-property. This allows using the Checkstyle property in your own
-custom checkstyle configuration file when specifying a suppressions
-file. </td>
+<td><strong><strong>Deprecated</strong>. {0}.</strong> Use suppressionsLocation instead.<br />
+</td>
</tr>
-<tr class="a"><td><strong><a href="#suppressionsFileExpression">suppressionsFileExpression</a>
-</strong></td>
+<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. Default value is: <code>checkstyle.suppressions.file</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>
+<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>
@@ -490,50 +517,46 @@ copied into the
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>
+<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. Default value is: <code>${project.build.testSourceDirectory}</code>.</td>
+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>
+<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
on stdout. Otherwise, a text file will be created with the
-violations. </td>
+violations.<br />
+</td>
</tr>
-<tr class="a"><td><strong><a href="#xrefLocation">xrefLocation</a>
-</strong></td>
+<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. Default value is: <code>${project.reporting.outputDirectory}/xref</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>
-<p>Specifies the cache file used to speed up Checkstyle on successive
-runs.</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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>
-<p><p>Specifies the location of the XML configuration to use.</p>
+<p><strong><a name="configLocation">configLocation</a>:</strong></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 href="http://checkstyle.sourceforge.net/config.html#Modules" class="externalLink">Checker
-module</a>
-) configuration of rulesets.</p>
+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
@@ -545,112 +568,88 @@ file before being passed to Checkstyle a
<li><code>config/avalon_checks.xml</code>: Avalon Checks.</li>
<li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
</ul>
-</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+</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>
-<p>Output errors to console.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>Specifies if the Files summary should be enabled or not.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>Specifies if the RSS should be enabled or not.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>Specifies if the Rules summary should be enabled or not.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>Specifies if the Severity summary should be enabled or not.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>The file encoding to use when reading the source files. If the
+<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.</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+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>
-<p>Specifies the names filter of the source files to be excluded for
-Checkstyle.</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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>
-<p>Specifies if the build should fail upon a violation.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>Specifies what predefined check set to use. Available sets are
-"sun" (for the Sun coding conventions), "turbine", and "avalon".</p>
-<ul><li><strong>Deprecated</strong>: <code>Use configLocation instead.</code></li>
-<li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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>
-<p>Specifies the location of the License file (a.k.a. the header file)
+<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)
that is used by Checkstyle to verify that source code has the
-correct license header.</p>
-<ul><li><strong>Deprecated</strong>: <code>Use headerLocation instead.</code></li>
-<li><strong>Type</strong>: <code>java.io.File</code></li>
+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>
-<p><p>Specifies the location of the License file (a.k.a. the header
+<p><strong><a name="headerLocation">headerLocation</a>:</strong></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
@@ -659,113 +658,90 @@ configuration to reference the name of t
<p><code><module name="RegexpHeader"> <property
name="headerFile" value="${checkstyle.header.file}"/>
</module></code></p>
-</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+</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>
-<p>Include or not the test source directory to be used for Checkstyle.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>Specifies the names filter of the source files to be used for
-Checkstyle.</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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>
-<p>Link the violation line numbers to the source xref. Will link
-automatically if Maven JXR plugin is being used.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>The output directory for the report. Note that this parameter is
+<p><strong><a name="outputDirectory">outputDirectory</a>:</strong></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.</p>
-<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+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>
-<p>Specifies the path and filename to save the checkstyle output. The
+<p><strong><a name="outputFile">outputFile</a>:</strong></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.</p>
-<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<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>
-<p>Specifies the format of the output to be used when writing to the
-output file. Valid values are "plain" and "xml".</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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>
-<p>Specifies the location of the package names XML to be used to
-configure Checkstyle.</p>
-<ul><li><strong>Deprecated</strong>: <code>Use packageNamesLocation instead.</code></li>
-<li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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>
-<p><p>Specifies the location of the package names XML to be used to
-configure the Checkstyle <a href="http://checkstyle.sourceforge.net/config.html#Packages" class="externalLink">Packages</a>
-.</p>
+<p><strong><a name="packageNamesLocation">packageNamesLocation</a>:</strong></p>
+<div><p>Specifies the location of the package names XML to be used to
+configure the Checkstyle <a href="http://checkstyle.sourceforge.net/config.html#Packages" class="externalLink">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>
-</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+</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>
-<p>Specifies the location of the Checkstyle properties file that will
-be used to check the source.</p>
-<ul><li><strong>Deprecated</strong>: <code>Use propertiesLocation instead.</code></li>
-<li><strong>Type</strong>: <code>java.io.File</code></li>
+<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>
-<p><p>Specifies the location of the properties file.</p>
+<p><strong><a name="propertiesLocation">propertiesLocation</a>:</strong></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
@@ -775,74 +751,58 @@ file before being passed to Checkstyle f
available to Checkstyle for specifying values for parameters within
the xml configuration (specified in the <code>configLocation</code>
parameter).</p>
-</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+</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>
-<p>Specifies the URL of the Checkstyle properties that will be used to
-check the source.</p>
-<ul><li><strong>Deprecated</strong>: <code>Use propertiesLocation instead.</code></li>
-<li><strong>Type</strong>: <code>java.net.URL</code></li>
+<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>
-<p>Allows for specifying raw property expansion information.</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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>
-<p>Skip entire check.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<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>
-<p>Specifies the location of the source directory to be used for
-Checkstyle.</p>
-<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<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>
-<p>Specifies the location of the suppressions XML file to use. The
+<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
plugin defines a Checkstyle property named
<code>checkstyle.suppressions.file</code> with the value of this
property. This allows using the Checkstyle property in your own
custom checkstyle configuration file when specifying a suppressions
-file.</p>
-<ul><li><strong>Deprecated</strong>: <code>Use suppressionsLocation instead.</code></li>
-<li><strong>Type</strong>: <code>java.lang.String</code></li>
+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>
-<p>The key to be used in the properties for the suppressions file.</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<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>
-<p><p>Specifies the location of the suppressions XML file to use.</p>
+<p><strong><a name="suppressionsLocation">suppressionsLocation</a>:</strong></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
@@ -850,36 +810,29 @@ copied into the
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>
-</p>
-<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+</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>
-<p>Specifies the location of the test source directory to be used for
-Checkstyle.</p>
-<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<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>
-<p>If <code>null</code>, the Checkstyle plugin will display violations
+<p><strong><a name="useFile">useFile</a>:</strong></p>
+<div>If <code>null</code>, the Checkstyle plugin will display violations
on stdout. Otherwise, a text file will be created with the
-violations.</p>
-<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+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>
-<p>Location of the Xrefs to link to.</p>
-<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<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>
@@ -893,7 +846,7 @@ violations.</p>
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -904,7 +857,7 @@ violations.</p>
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>