You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by hb...@apache.org on 2014/09/18 00:57:28 UTC
svn commit: r922623 [8/28] - in
/websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST:
./ apidocs/ apidocs/org/apache/maven/plugin/checkstyle/
apidocs/org/apache/maven/plugin/checkstyle/class-use/
apidocs/org/apache/maven/p...
Modified: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html (original)
+++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html Wed Sep 17 22:57:25 2014
@@ -1,19 +1,18 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
- | Generated by Apache Maven Doxia at 2014-07-14
+ | Generated by Apache Maven Doxia at 2014-09-18
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Apache Maven Checkstyle Plugin -
- checkstyle:check</title>
+ <title>Apache 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 name="Date-Revision-yyyymmdd" content="20140714" />
+ <meta name="Date-Revision-yyyymmdd" content="20140918" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
@@ -44,12 +43,11 @@
>
<a href="./">Apache Maven Checkstyle Plugin</a>
>
-
- checkstyle:check
+ checkstyle:check
</div>
<div class="xright">
- Last Published: 2014-07-14
- | Version: 2.13-SNAPSHOT
+ Last Published: 2014-09-18
+ | Version: 2.13
</div>
<div class="clear">
<hr/>
@@ -180,11 +178,11 @@
<div class="section">
-<h2>checkstyle:check<a name="checkstyle:check"></a></h2>
+<h2><a name="checkstyle:check"></a>checkstyle:check</h2>
<p><b>Full name</b>:</p>
-<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.13-SNAPSHOT:check</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.13:check</p>
<p><b>Description</b>:</p>
@@ -206,7 +204,7 @@ also be configured to re-use an earlier
</ul>
<div class="section">
-<h3>Required Parameters<a name="Required_Parameters"></a></h3>
+<h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable" border="0">
@@ -266,23 +264,11 @@ Checkstyle.<br /><b>Default value is</b>
<td>Specifies the names filter of the files to be used for Checkstyle
when checking resources.<br /><b>Default value is</b>: <tt>**/*.properties</tt>.<br /><b>User property is</b>: <tt>checkstyle.resourceIncludes</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>.<br /></td>
- </tr>
</table>
</div>
<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable" border="0">
@@ -317,7 +303,7 @@ runs.<br /><b>Default value is</b>: <tt>
<td><tt>2.12</tt></td>
-<td>By using this property, you can specify the whole checkstyle rules
+<td>By using this property, you can specify the whole Checkstyle rules
inline directly inside this pom.
<div>
@@ -436,8 +422,8 @@ build immediately before examining the o
<td><tt>-</tt></td>
-<td>If this is true, and checkstyle reported any violations or errors,
-the build fails immediately after running checkstyle, before
+<td>If this is true, and Checkstyle reported any violations or errors,
+the build fails immediately after running Checkstyle, before
checking the log for <tt>logViolationsToConsole</tt>. If you
want to use <tt>logViolationsToConsole</tt>, use
<tt>failOnViolation</tt> instead of this.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
@@ -485,7 +471,7 @@ name="headerFile" value="
<td><tt>2.3</tt></td>
-<td>Output the detected violations to the console.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.console</tt>.</td>
+<td>Output the detected violations to the console.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.console</tt>.</td>
</tr>
<tr class="a">
@@ -522,7 +508,8 @@ format of the output file is determined
<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>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
+output file. Valid values are "<tt>plain</tt>" and
+"<tt>xml</tt>".<br /><b>Default value is</b>: <tt>xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
</tr>
<tr class="b">
@@ -579,7 +566,7 @@ Checkstyle when checking resources.<br /
<td><tt>-</tt></td>
-<td>dump file for inlined checkstyle rules<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-rules.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.rules.file</tt>.</td>
+<td>dump file for inlined Checkstyle rules<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-rules.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.rules.file</tt>.</td>
</tr>
<tr class="b">
@@ -601,7 +588,30 @@ Checkstyle when checking resources.<br /
<td><tt>2.5</tt></td>
-<td>Skip checktyle execution will only scan the outputFile.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skipExec</tt>.</td>
+<td>Skip Checkstyle execution will only scan the outputFile.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skipExec</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#sourceDirectories">sourceDirectories</a></b></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>2.13</tt></td>
+
+<td>Specifies the location of the source directories to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>${project.compileSourceRoots}</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>-</tt></td>
+
+<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt><br /></td>
</tr>
<tr class="b">
@@ -629,26 +639,37 @@ Checkstyle when checking resources.<br /
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the suppressions XML is
copied into the
-<tt>${project.build.directory}/checkstyle-supressions.xml</tt>
+<tt>${project.build.directory}/checkstyle-suppressions.xml</tt>
file before being passed to Checkstyle for loading.</p>
<p>See <tt>suppressionsFileExpression</tt> for the property
-that will be made available to your checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
+that will be made available to your Checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
</tr>
<tr class="b">
+<td><b><a href="#testSourceDirectories">testSourceDirectories</a></b></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>2.13</tt></td>
+
+<td>Specifies the location of the test source directories to be used
+for Checkstyle.<br /><b>Default value is</b>: <tt>${project.testCompileSourceRoots}</tt>.<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>.<br /></td>
+<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt><br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#useFile">useFile</a></b></td>
@@ -661,6 +682,19 @@ on stdout. Otherwise, a text file will b
violations.<br /></td>
</tr>
+<tr class="a">
+
+<td><b><a href="#violationIgnore">violationIgnore</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.13</tt></td>
+
+<td>Violations to ignore. This is a comma-separated list, each value
+being either a rule name, a rule category or a java package name of
+rule class.<br /><b>User property is</b>: <tt>checkstyle.violation.ignore</tt>.</td>
+ </tr>
+
<tr class="b">
<td><b><a href="#violationSeverity">violationSeverity</a></b></td>
@@ -670,13 +704,14 @@ violations.<br /></td>
<td><tt>2.2</tt></td>
<td>The lowest severity level that is considered a violation. Valid
-values are "error", "warning" and "info".<br /><b>Default value is</b>: <tt>error</tt>.<br /><b>User property is</b>: <tt>checkstyle.violationSeverity</tt>.</td>
+values are "<tt>error</tt>", "<tt>warning</tt>" and
+"<tt>info</tt>".<br /><b>Default value is</b>: <tt>error</tt>.<br /><b>User property is</b>: <tt>checkstyle.violationSeverity</tt>.</td>
</tr>
</table>
</div>
<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
+<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><b><a name="cacheFile">cacheFile</a>:</b></p>
@@ -693,7 +728,7 @@ runs.</div>
</ul><hr />
<p><b><a name="checkstyleRules">checkstyleRules</a>:</b></p>
-<div>By using this property, you can specify the whole checkstyle rules
+<div>By using this property, you can specify the whole Checkstyle rules
inline directly inside this pom.
<div>
@@ -830,8 +865,8 @@ build immediately before examining the o
</ul><hr />
<p><b><a name="failsOnError">failsOnError</a>:</b></p>
-<div>If this is true, and checkstyle reported any violations or errors,
-the build fails immediately after running checkstyle, before
+<div>If this is true, and Checkstyle reported any violations or errors,
+the build fails immediately after running Checkstyle, before
checking the log for <tt>logViolationsToConsole</tt>. If you
want to use <tt>logViolationsToConsole</tt>, use
<tt>failOnViolation</tt> instead of this.</div>
@@ -947,7 +982,7 @@ Checkstyle.</div>
<li><b>User Property</b>: <tt>checkstyle.console</tt></li>
-<li><b>Default</b>: <tt>false</tt></li>
+<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="maxAllowedViolations">maxAllowedViolations</a>:</b></p>
@@ -985,7 +1020,8 @@ format of the output file is determined
<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>
+output file. Valid values are "<tt>plain</tt>" and
+"<tt>xml</tt>".</div>
<ul>
@@ -1067,7 +1103,7 @@ when checking resources.</div>
</ul><hr />
<p><b><a name="rulesFiles">rulesFiles</a>:</b></p>
-<div>dump file for inlined checkstyle rules</div>
+<div>dump file for inlined Checkstyle rules</div>
<ul>
@@ -1097,7 +1133,7 @@ when checking resources.</div>
</ul><hr />
<p><b><a name="skipExec">skipExec</a>:</b></p>
-<div>Skip checktyle execution will only scan the outputFile.</div>
+<div>Skip Checkstyle execution will only scan the outputFile.</div>
<ul>
@@ -1111,8 +1147,25 @@ when checking resources.</div>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
+<p><b><a name="sourceDirectories">sourceDirectories</a>:</b></p>
+
+<div>Specifies the location of the source directories to be used for
+Checkstyle.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>2.13</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.compileSourceRoots}</tt></li>
+ </ul><hr />
<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
+<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt></div>
+
<div>Specifies the location of the source directory to be used for
Checkstyle.</div>
@@ -1120,9 +1173,7 @@ Checkstyle.</div>
<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>
+<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="suppressionsFileExpression">suppressionsFileExpression</a>:</b></p>
@@ -1148,11 +1199,11 @@ Checkstyle.</div>
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the suppressions XML is
copied into the
-<tt>${project.build.directory}/checkstyle-supressions.xml</tt>
+<tt>${project.build.directory}/checkstyle-suppressions.xml</tt>
file before being passed to Checkstyle for loading.</p>
<p>See <tt>suppressionsFileExpression</tt> for the property
-that will be made available to your checkstyle configuration.</p></div>
+that will be made available to your Checkstyle configuration.</p></div>
<ul>
@@ -1164,8 +1215,25 @@ that will be made available to your chec
<li><b>User Property</b>: <tt>checkstyle.suppressions.location</tt></li>
</ul><hr />
+<p><b><a name="testSourceDirectories">testSourceDirectories</a>:</b></p>
+
+<div>Specifies the location of the test source directories to be used
+for Checkstyle.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>2.13</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.testCompileSourceRoots}</tt></li>
+ </ul><hr />
<p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
+<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt></div>
+
<div>Specifies the location of the test source directory to be used for
Checkstyle.</div>
@@ -1176,8 +1244,6 @@ Checkstyle.</div>
<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>
@@ -1191,10 +1257,27 @@ violations.</div>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
+<p><b><a name="violationIgnore">violationIgnore</a>:</b></p>
+
+<div>Violations to ignore. This is a comma-separated list, each value
+being either a rule name, a rule category or a java package name of
+rule class.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.13</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.violation.ignore</tt></li>
+ </ul><hr />
<p><b><a name="violationSeverity">violationSeverity</a>:</b></p>
<div>The lowest severity level that is considered a violation. Valid
-values are "error", "warning" and "info".</div>
+values are "<tt>error</tt>", "<tt>warning</tt>" and
+"<tt>info</tt>".</div>
<ul>
Modified: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html (original)
+++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-aggregate-mojo.html Wed Sep 17 22:57:25 2014
@@ -1,19 +1,18 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
- | Generated by Apache Maven Doxia at 2014-07-14
+ | Generated by Apache Maven Doxia at 2014-09-18
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Apache Maven Checkstyle Plugin -
- checkstyle:checkstyle-aggregate</title>
+ <title>Apache Maven Checkstyle Plugin – checkstyle:checkstyle-aggregate</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20140714" />
+ <meta name="Date-Revision-yyyymmdd" content="20140918" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
@@ -44,12 +43,11 @@
>
<a href="./">Apache Maven Checkstyle Plugin</a>
>
-
- checkstyle:checkstyle-aggregate
+ checkstyle:checkstyle-aggregate
</div>
<div class="xright">
- Last Published: 2014-07-14
- | Version: 2.13-SNAPSHOT
+ Last Published: 2014-09-18
+ | Version: 2.13
</div>
<div class="clear">
<hr/>
@@ -180,13 +178,13 @@
<div class="section">
-<h2>checkstyle:checkstyle-aggregate<a name="checkstyle:checkstyle-aggregate"></a></h2>
+<h2><a name="checkstyle:checkstyle-aggregate"></a>checkstyle:checkstyle-aggregate</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.13-SNAPSHOT:checkstyle-aggregate</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.13:checkstyle-aggregate</p>
<p><b>Description</b>:</p>
@@ -210,7 +208,7 @@ multi-module reactor build.</div>
</ul>
<div class="section">
-<h3>Required Parameters<a name="Required_Parameters"></a></h3>
+<h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable" border="0">
@@ -262,20 +260,6 @@ Checkstyle.<br /><b>Default value is</b>
<tr class="a">
-<td><b><a href="#outputDirectory">outputDirectory</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>2.8</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 /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
<td><b><a href="#resourceIncludes">resourceIncludes</a></b></td>
<td><tt>String</tt></td>
@@ -285,23 +269,11 @@ output directory configured in Maven Sit
<td>Specifies the names filter of the resource files to be used for
Checkstyle.<br /><b>Default value is</b>: <tt>**/*.properties</tt>.<br /><b>User property is</b>: <tt>checkstyle.resourceIncludes</tt>.</td>
</tr>
-
-<tr class="a">
-
-<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>2.8</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>.<br /></td>
- </tr>
</table>
</div>
<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable" border="0">
@@ -488,7 +460,8 @@ name="headerFile" value="
<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>.<br /></td>
+<td>Include or not the test source directory/directories to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
</tr>
<tr class="b">
@@ -511,7 +484,7 @@ automatically if Maven JXR plugin is bei
<td><tt>2.8</tt></td>
-<td>Specifies the path and filename to save the checkstyle output. The
+<td>Specifies the path and filename to save the Checkstyle output. The
format of the output file is determined by the
<tt>outputFileFormat</tt> parameter.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.file</tt>.</td>
</tr>
@@ -525,7 +498,8 @@ format of the output file is determined
<td><tt>2.8</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>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
+output file. Valid values are "<tt>plain</tt>" and
+"<tt>xml</tt>".<br /><b>Default value is</b>: <tt>xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
</tr>
<tr class="a">
@@ -587,6 +561,29 @@ Checkstyle.<br /><b>User property is</b>
<tr class="a">
+<td><b><a href="#sourceDirectories">sourceDirectories</a></b></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>2.13</tt></td>
+
+<td>Specifies the location of the source directories to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>${project.compileSourceRoots}</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>2.8</tt></td>
+
+<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt><br /></td>
+ </tr>
+
+<tr class="a">
+
<td><b><a href="#suppressionsFileExpression">suppressionsFileExpression</a></b></td>
<td><tt>String</tt></td>
@@ -614,22 +611,33 @@ copied into the
file before being passed to Checkstyle for loading.</p>
<p>See <tt>suppressionsFileExpression</tt> for the property
-that will be made available to your checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
+that will be made available to your Checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
</tr>
<tr class="a">
+<td><b><a href="#testSourceDirectories">testSourceDirectories</a></b></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>2.13</tt></td>
+
+<td>Specifies the location of the test source directories to be used
+for Checkstyle.<br /><b>Default value is</b>: <tt>${project.testCompileSourceRoots}</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
<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>.<br /></td>
+<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt><br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#treeWalkerNames">treeWalkerNames</a></b></td>
@@ -641,7 +649,7 @@ Checkstyle.<br /><b>Default value is</b>
checks inside the treeWalker end up the the rule-summary.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#useFile">useFile</a></b></td>
@@ -654,7 +662,7 @@ on stdout. Otherwise, a text file will b
violations.<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#xrefLocation">xrefLocation</a></b></td>
@@ -668,7 +676,7 @@ violations.<br /></td>
</div>
<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
+<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><b><a name="cacheFile">cacheFile</a>:</b></p>
@@ -918,7 +926,8 @@ check.</div>
</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>
+<div>Include or not the test source directory/directories to be used for
+Checkstyle.</div>
<ul>
@@ -964,26 +973,9 @@ automatically if Maven JXR plugin is bei
<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><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Since</b>: <tt>2.8</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
+<div>Specifies the path and filename to save the Checkstyle output. The
format of the output file is determined by the
<tt>outputFileFormat</tt> parameter.</div>
@@ -1002,7 +994,8 @@ format of the output file is determined
<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>
+output file. Valid values are "<tt>plain</tt>" and
+"<tt>xml</tt>".</div>
<ul>
@@ -1102,8 +1095,25 @@ Checkstyle.</div>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
+<p><b><a name="sourceDirectories">sourceDirectories</a>:</b></p>
+
+<div>Specifies the location of the source directories to be used for
+Checkstyle.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>2.13</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.compileSourceRoots}</tt></li>
+ </ul><hr />
<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
+<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt></div>
+
<div>Specifies the location of the source directory to be used for
Checkstyle.</div>
@@ -1113,9 +1123,7 @@ Checkstyle.</div>
<li><b>Since</b>: <tt>2.8</tt></li>
-<li><b>Required</b>: <tt>Yes</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.sourceDirectory}</tt></li>
+<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="suppressionsFileExpression">suppressionsFileExpression</a>:</b></p>
@@ -1145,7 +1153,7 @@ copied into the
file before being passed to Checkstyle for loading.</p>
<p>See <tt>suppressionsFileExpression</tt> for the property
-that will be made available to your checkstyle configuration.</p></div>
+that will be made available to your Checkstyle configuration.</p></div>
<ul>
@@ -1157,8 +1165,25 @@ that will be made available to your chec
<li><b>User Property</b>: <tt>checkstyle.suppressions.location</tt></li>
</ul><hr />
+<p><b><a name="testSourceDirectories">testSourceDirectories</a>:</b></p>
+
+<div>Specifies the location of the test source directories to be used
+for Checkstyle.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>2.13</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.testCompileSourceRoots}</tt></li>
+ </ul><hr />
<p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
+<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt></div>
+
<div>Specifies the location of the test source directory to be used for
Checkstyle.</div>
@@ -1169,8 +1194,6 @@ Checkstyle.</div>
<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="treeWalkerNames">treeWalkerNames</a>:</b></p>
Modified: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-mojo.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-mojo.html (original)
+++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/checkstyle-mojo.html Wed Sep 17 22:57:25 2014
@@ -1,19 +1,18 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
- | Generated by Apache Maven Doxia at 2014-07-14
+ | Generated by Apache Maven Doxia at 2014-09-18
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Apache Maven Checkstyle Plugin -
- checkstyle:checkstyle</title>
+ <title>Apache 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 name="Date-Revision-yyyymmdd" content="20140714" />
+ <meta name="Date-Revision-yyyymmdd" content="20140918" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
@@ -44,12 +43,11 @@
>
<a href="./">Apache Maven Checkstyle Plugin</a>
>
-
- checkstyle:checkstyle
+ checkstyle:checkstyle
</div>
<div class="xright">
- Last Published: 2014-07-14
- | Version: 2.13-SNAPSHOT
+ Last Published: 2014-09-18
+ | Version: 2.13
</div>
<div class="clear">
<hr/>
@@ -180,13 +178,13 @@
<div class="section">
-<h2>checkstyle:checkstyle<a name="checkstyle:checkstyle"></a></h2>
+<h2><a name="checkstyle:checkstyle"></a>checkstyle:checkstyle</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.13-SNAPSHOT:checkstyle</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.13:checkstyle</p>
<p><b>Description</b>:</p>
@@ -207,7 +205,7 @@ HTML report on any violations that Check
</ul>
<div class="section">
-<h3>Required Parameters<a name="Required_Parameters"></a></h3>
+<h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable" border="0">
@@ -259,20 +257,6 @@ Checkstyle.<br /><b>Default value is</b>
<tr class="a">
-<td><b><a href="#outputDirectory">outputDirectory</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>2.8</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 /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.<br /></td>
- </tr>
-
-<tr class="b">
-
<td><b><a href="#resourceIncludes">resourceIncludes</a></b></td>
<td><tt>String</tt></td>
@@ -282,23 +266,11 @@ output directory configured in Maven Sit
<td>Specifies the names filter of the resource files to be used for
Checkstyle.<br /><b>Default value is</b>: <tt>**/*.properties</tt>.<br /><b>User property is</b>: <tt>checkstyle.resourceIncludes</tt>.</td>
</tr>
-
-<tr class="a">
-
-<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
-
-<td><tt>File</tt></td>
-
-<td><tt>2.8</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>.<br /></td>
- </tr>
</table>
</div>
<div class="section">
-<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable" border="0">
@@ -507,7 +479,8 @@ name="headerFile" value="
<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>.<br /></td>
+<td>Include or not the test source directory/directories to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
</tr>
<tr class="b">
@@ -530,7 +503,7 @@ automatically if Maven JXR plugin is bei
<td><tt>2.8</tt></td>
-<td>Specifies the path and filename to save the checkstyle output. The
+<td>Specifies the path and filename to save the Checkstyle output. The
format of the output file is determined by the
<tt>outputFileFormat</tt> parameter.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.file</tt>.</td>
</tr>
@@ -544,7 +517,8 @@ format of the output file is determined
<td><tt>2.8</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>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
+output file. Valid values are "<tt>plain</tt>" and
+"<tt>xml</tt>".<br /><b>Default value is</b>: <tt>xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
</tr>
<tr class="a">
@@ -658,6 +632,29 @@ Checkstyle.<br /><b>User property is</b>
<tr class="a">
+<td><b><a href="#sourceDirectories">sourceDirectories</a></b></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>2.13</tt></td>
+
+<td>Specifies the location of the source directories to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>${project.compileSourceRoots}</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>2.8</tt></td>
+
+<td><b>Deprecated.</b> instead use <tt>sourceDirectories</tt><br /></td>
+ </tr>
+
+<tr class="a">
+
<td><b><a href="#suppressionsFile">suppressionsFile</a></b></td>
<td><tt>String</tt></td>
@@ -696,22 +693,33 @@ copied into the
file before being passed to Checkstyle for loading.</p>
<p>See <tt>suppressionsFileExpression</tt> for the property
-that will be made available to your checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
+that will be made available to your Checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
</tr>
<tr class="b">
+<td><b><a href="#testSourceDirectories">testSourceDirectories</a></b></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>2.13</tt></td>
+
+<td>Specifies the location of the test source directories to be used
+for Checkstyle.<br /><b>Default value is</b>: <tt>${project.testCompileSourceRoots}</tt>.<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>.<br /></td>
+<td><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt><br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#treeWalkerNames">treeWalkerNames</a></b></td>
@@ -723,7 +731,7 @@ Checkstyle.<br /><b>Default value is</b>
checks inside the treeWalker end up the the rule-summary.<br /></td>
</tr>
-<tr class="b">
+<tr class="a">
<td><b><a href="#useFile">useFile</a></b></td>
@@ -736,7 +744,7 @@ on stdout. Otherwise, a text file will b
violations.<br /></td>
</tr>
-<tr class="a">
+<tr class="b">
<td><b><a href="#xrefLocation">xrefLocation</a></b></td>
@@ -750,7 +758,7 @@ violations.<br /></td>
</div>
<div class="section">
-<h3>Parameter Details<a name="Parameter_Details"></a></h3>
+<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><b><a name="cacheFile">cacheFile</a>:</b></p>
@@ -1035,7 +1043,8 @@ check.</div>
</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>
+<div>Include or not the test source directory/directories to be used for
+Checkstyle.</div>
<ul>
@@ -1081,26 +1090,9 @@ automatically if Maven JXR plugin is bei
<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><b>Type</b>: <tt>java.io.File</tt></li>
-
-<li><b>Since</b>: <tt>2.8</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
+<div>Specifies the path and filename to save the Checkstyle output. The
format of the output file is determined by the
<tt>outputFileFormat</tt> parameter.</div>
@@ -1119,7 +1111,8 @@ format of the output file is determined
<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>
+output file. Valid values are "<tt>plain</tt>" and
+"<tt>xml</tt>".</div>
<ul>
@@ -1284,8 +1277,25 @@ Checkstyle.</div>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
+<p><b><a name="sourceDirectories">sourceDirectories</a>:</b></p>
+
+<div>Specifies the location of the source directories to be used for
+Checkstyle.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>2.13</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.compileSourceRoots}</tt></li>
+ </ul><hr />
<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
+<div><b>Deprecated.</b> instead use <tt>sourceDirectories</tt></div>
+
<div>Specifies the location of the source directory to be used for
Checkstyle.</div>
@@ -1295,9 +1305,7 @@ Checkstyle.</div>
<li><b>Since</b>: <tt>2.8</tt></li>
-<li><b>Required</b>: <tt>Yes</tt></li>
-
-<li><b>Default</b>: <tt>${project.build.sourceDirectory}</tt></li>
+<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="suppressionsFile">suppressionsFile</a>:</b></p>
@@ -1307,7 +1315,7 @@ Checkstyle.</div>
plugin defines a Checkstyle property named
<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
+custom Checkstyle configuration file when specifying a suppressions
file.</div>
<ul>
@@ -1346,7 +1354,7 @@ copied into the
file before being passed to Checkstyle for loading.</p>
<p>See <tt>suppressionsFileExpression</tt> for the property
-that will be made available to your checkstyle configuration.</p></div>
+that will be made available to your Checkstyle configuration.</p></div>
<ul>
@@ -1358,8 +1366,25 @@ that will be made available to your chec
<li><b>User Property</b>: <tt>checkstyle.suppressions.location</tt></li>
</ul><hr />
+<p><b><a name="testSourceDirectories">testSourceDirectories</a>:</b></p>
+
+<div>Specifies the location of the test source directories to be used
+for Checkstyle.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>2.13</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.testCompileSourceRoots}</tt></li>
+ </ul><hr />
<p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
+<div><b>Deprecated.</b> instead use <tt>testSourceDirectories</tt></div>
+
<div>Specifies the location of the test source directory to be used for
Checkstyle.</div>
@@ -1370,8 +1395,6 @@ Checkstyle.</div>
<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="treeWalkerNames">treeWalkerNames</a>:</b></p>