You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2013/02/22 19:41:52 UTC
svn commit: r851556 [7/33] - in
/websites/production/maven/content/plugins/maven-checkstyle-plugin: ./
apidocs/ apidocs/org/apache/maven/plugin/checkstyle/
apidocs/org/apache/maven/plugin/checkstyle/class-use/
apidocs/org/apache/maven/plugin/checkstyle...
Modified: websites/production/maven/content/plugins/maven-checkstyle-plugin/checkstyle-mojo.html
==============================================================================
--- websites/production/maven/content/plugins/maven-checkstyle-plugin/checkstyle-mojo.html (original)
+++ websites/production/maven/content/plugins/maven-checkstyle-plugin/checkstyle-mojo.html Fri Feb 22 18:41:48 2013
@@ -1,167 +1,179 @@
-<!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 Feb 25, 2012 -->
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>
- 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="20120225" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<!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 Feb 22, 2013
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <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 name="Date-Revision-yyyymmdd" content="20130222" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
+<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
<script type="text/javascript">_uacct = "UA-140879-1";
- urchinTracker();</script>
- </head>
- <body class="composite">
- <div id="banner">
- <a href="../../" id="bannerLeft">
- <img src="../../images/apache-maven-project-2.png" alt="" />
- </a>
- <span id="bannerRight">
- <img src="../../images/maven-logo-2.gif" alt="" />
- </span>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="breadcrumbs">
-
- <div class="xleft">
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
- <a href="../../index.html">Maven</a>
- >
- <a href="../index.html">Plugins</a>
- >
- <a href="./">Maven Checkstyle Plugin</a>
- >
-
- checkstyle:checkstyle
- </div>
- <div class="xright">
- Last Published: 2012-02-25
- | Version: 2.9.1
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>Overview</h5>
- <ul>
- <li class="none">
- <a href="index.html">Introduction</a>
- </li>
- <li class="none">
- <a href="plugin-info.html">Goals</a>
- </li>
- <li class="none">
- <a href="usage.html">Usage</a>
- </li>
- <li class="none">
- <a href="faq.html">FAQ</a>
- </li>
- </ul>
- <h5>Examples</h5>
- <ul>
- <li class="none">
- <a href="examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
- </li>
- <li class="none">
- <a href="examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
- </li>
- <li class="none">
- <a href="examples/suppressions-filter.html">Using a Suppressions Filter</a>
- </li>
- <li class="none">
- <a href="examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
- </li>
- <li class="none">
- <a href="examples/multi-module-config.html">Multimodule Configuration</a>
- </li>
- </ul>
- <h5>Project Documentation</h5>
- <ul>
- <li class="collapsed">
- <a href="project-info.html">Project Information</a>
- </li>
- <li class="collapsed">
- <a href="project-reports.html">Project Reports</a>
- </li>
- </ul>
- <h5>Maven Projects</h5>
- <ul>
- <li class="none">
- <a href="../../ant-tasks/index.html">Ant Tasks</a>
- </li>
- <li class="none">
- <a href="../../archetype/index.html">Archetype</a>
- </li>
- <li class="none">
- <a href="../../doxia/index.html">Doxia</a>
- </li>
- <li class="none">
- <a href="../../jxr/index.html">JXR</a>
- </li>
- <li class="none">
- <a href="../../maven-1.x/index.html">Maven 1.x</a>
- </li>
- <li class="none">
- <a href="../../index.html">Maven 2 & 3</a>
- </li>
- <li class="none">
- <a href="../index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../scm/index.html">SCM</a>
- </li>
- <li class="none">
- <a href="../../shared/index.html">Shared Components</a>
- </li>
- <li class="none">
- <a href="../../surefire/index.html">Surefire</a>
- </li>
- <li class="none">
- <a href="../../wagon/index.html">Wagon</a>
- </li>
- </ul>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</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"/>
- </a>
-
- </div>
- </div>
- <div id="bodyColumn">
- <div id="contentBox">
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../../" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ <a href="../index.html">Plugins</a>
+ >
+ <a href="./">Maven Checkstyle Plugin</a>
+ >
+
+ checkstyle:checkstyle
+ </div>
+ <div class="xright">
+ Last Published: 2013-02-22
+ | Version: 2.10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="plugin-info.html">Goals</a>
+ </li>
+ <li class="none">
+ <a href="usage.html">Usage</a>
+ </li>
+ <li class="none">
+ <a href="faq.html">FAQ</a>
+ </li>
+ </ul>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <a href="examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
+ </li>
+ <li class="none">
+ <a href="examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
+ </li>
+ <li class="none">
+ <a href="examples/suppressions-filter.html">Using a Suppressions Filter</a>
+ </li>
+ <li class="none">
+ <a href="examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
+ </li>
+ <li class="none">
+ <a href="examples/multi-module-config.html">Multimodule Configuration</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html">Project Reports</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</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"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
<div class="section"><h2>checkstyle:checkstyle<a name="checkstyle:checkstyle"></a></h2>
<p><b>Note</b>:This goal should be used as a Maven report.</p>
<p><b>Full name</b>:</p>
- <p>org.apache.maven.plugins:maven-checkstyle-plugin:2.9.1:checkstyle</p>
+ <p>org.apache.maven.plugins:maven-checkstyle-plugin:2.10:checkstyle</p>
<p><b>Description</b>:</p>
<div>Perform a Checkstyle analysis, and generate a report on violations.</div>
<p><b>Attributes</b>:</p>
@@ -184,7 +196,8 @@
<td><tt>String</tt></td>
<td><tt>2.8</tt></td>
<td>Specifies the names filter of the source files to be used for
-Checkstyle.<br /><b>Default value is</b>: <tt>**/*.java</tt>.</td>
+Checkstyle. <b>Note:</b> default value is
+<tt>**\/*.java</tt>.<br /><b>Default value is</b>: <tt>**\/*.java</tt>.<br /><b>User property is</b>: <tt>checkstyle.includes</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#outputDirectory">outputDirectory</a></b></td>
@@ -193,14 +206,14 @@ Checkstyle.<br /><b>Default value is</b>
<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>.</td>
+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="#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>.</td>
+Checkstyle.<br /><b>Default value is</b>: <tt>${project.build.sourceDirectory}</tt>.<br /></td>
</tr>
</table>
</div>
@@ -217,7 +230,7 @@ Checkstyle.<br /><b>Default value is</b>
<td><tt>String</tt></td>
<td><tt>2.8</tt></td>
<td>Specifies the cache file used to speed up Checkstyle on successive
-runs.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-cachefile</tt>.</td>
+runs.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-cachefile</tt>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#configLocation">configLocation</a></b></td>
@@ -239,37 +252,37 @@ file before being passed to Checkstyle a
<li><tt>config/turbine_checks.xml</tt>: Turbine Checks.</li>
<li><tt>config/avalon_checks.xml</tt>: Avalon Checks.</li>
<li><tt>config/maven_checks.xml</tt>: Maven Source Checks.</li>
-</ul><br /><b>Default value is</b>: <tt>config/sun_checks.xml</tt>.</td>
+</ul><br /><b>Default value is</b>: <tt>config/sun_checks.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.config.location</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#consoleOutput">consoleOutput</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.8</tt></td>
- <td>Output errors to console.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ <td>Output errors to console.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#enableFilesSummary">enableFilesSummary</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.8</tt></td>
- <td>Specifies if the Files summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ <td>Specifies if the Files summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.enable.files.summary</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#enableRSS">enableRSS</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.8</tt></td>
- <td>Specifies if the RSS should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ <td>Specifies if the RSS should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.enable.rss</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#enableRulesSummary">enableRulesSummary</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.8</tt></td>
- <td>Specifies if the Rules summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ <td>Specifies if the Rules summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.enable.rules.summary</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#enableSeveritySummary">enableSeveritySummary</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.8</tt></td>
- <td>Specifies if the Severity summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ <td>Specifies if the Severity summary should be enabled or not.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.enable.severity.summary</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#encoding">encoding</a></b></td>
@@ -279,32 +292,32 @@ file before being passed to Checkstyle a
property <tt>project.build.sourceEncoding</tt> is not set, the
platform default encoding is used. <b>Note:</b> This
parameter always overrides the property <tt>charset</tt> from
-Checkstyle's <tt>TreeWalker</tt> module.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.</td>
+Checkstyle's <tt>TreeWalker</tt> module.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.<br /><b>User property is</b>: <tt>encoding</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#excludes">excludes</a></b></td>
<td><tt>String</tt></td>
<td><tt>2.8</tt></td>
<td>Specifies the names filter of the source files to be excluded for
-Checkstyle.<br /></td>
+Checkstyle.<br /><b>User property is</b>: <tt>checkstyle.excludes</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#failsOnError">failsOnError</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.8</tt></td>
- <td>Specifies if the build should fail upon a violation.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ <td>Specifies if the build should fail upon a violation.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#format">format</a></b></td>
<td><tt>String</tt></td>
<td><tt>2.8</tt></td>
- <td><b>Deprecated.</b> Use configLocation instead.<br /><b>Default value is</b>: <tt>sun</tt>.</td>
+ <td><b>Deprecated.</b> Use configLocation instead.<br /><b>Default value is</b>: <tt>sun</tt>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#headerFile">headerFile</a></b></td>
<td><tt>File</tt></td>
<td><tt>2.8</tt></td>
- <td><b>Deprecated.</b> Use headerLocation instead.<br /></td>
+ <td><b>Deprecated.</b> Use headerLocation instead.<br /><b>Default value is</b>: <tt>${basedir}/LICENSE.txt</tt>.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#headerLocation">headerLocation</a></b></td>
@@ -318,20 +331,20 @@ configuration to reference the name of t
<p>For instance:</p>
<p><tt><module name="RegexpHeader"> <property
name="headerFile" value="${checkstyle.header.file}"/>
-</module></tt></p><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.</td>
+</module></tt></p><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.<br /><b>User property is</b>: <tt>checkstyle.header.file</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#includeTestSourceDirectory">includeTestSourceDirectory</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.2</tt></td>
- <td>Include or not the test source directory to be used for Checkstyle.<br /><b>Default value is</b>: <tt>${false}</tt>.</td>
+ <td>Include or not the test source directory to be used for Checkstyle.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#linkXRef">linkXRef</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.1</tt></td>
<td>Link the violation line numbers to the source xref. Will link
-automatically if Maven JXR plugin is being used.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+automatically if Maven JXR plugin is being used.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>linkXRef</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#outputFile">outputFile</a></b></td>
@@ -339,14 +352,14 @@ 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
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>.</td>
+<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>
<tr class="b">
<td><b><a href="#outputFileFormat">outputFileFormat</a></b></td>
<td><tt>String</tt></td>
<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>.</td>
+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>
</tr>
<tr class="a">
<td><b><a href="#packageNamesFile">packageNamesFile</a></b></td>
@@ -385,7 +398,7 @@ file before being passed to Checkstyle f
<p>The contents of the <tt>propertiesLocation</tt> will be made
available to Checkstyle for specifying values for parameters within
the xml configuration (specified in the <tt>configLocation</tt>
-parameter).</p><br /></td>
+parameter).</p><br /><b>User property is</b>: <tt>checkstyle.properties.location</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#propertiesURL">propertiesURL</a></b></td>
@@ -403,7 +416,7 @@ parameter).</p><br /></td>
<td><b><a href="#skip">skip</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>2.2</tt></td>
- <td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ <td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skip</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#suppressionsFile">suppressionsFile</a></b></td>
@@ -415,7 +428,7 @@ parameter).</p><br /></td>
<td><b><a href="#suppressionsFileExpression">suppressionsFileExpression</a></b></td>
<td><tt>String</tt></td>
<td><tt>2.1</tt></td>
- <td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <tt>checkstyle.suppressions.file</tt>.</td>
+ <td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <tt>checkstyle.suppressions.file</tt>.<br /><b>User property is</b>: <tt>checkstyle.suppression.expression</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#suppressionsLocation">suppressionsLocation</a></b></td>
@@ -428,14 +441,14 @@ copied into the
<tt>${project.build.directory}/checkstyle-supressions.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 /></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="#testSourceDirectory">testSourceDirectory</a></b></td>
<td><tt>File</tt></td>
<td><tt>2.2</tt></td>
<td>Specifies the location of the test source directory to be used for
-Checkstyle.<br /><b>Default value is</b>: <tt>${project.build.testSourceDirectory}</tt>.</td>
+Checkstyle.<br /><b>Default value is</b>: <tt>${project.build.testSourceDirectory}</tt>.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#useFile">useFile</a></b></td>
@@ -449,7 +462,7 @@ violations.<br /></td>
<td><b><a href="#xrefLocation">xrefLocation</a></b></td>
<td><tt>File</tt></td>
<td><tt>2.8</tt></td>
- <td>Location of the Xrefs to link to.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}/xref</tt>.</td>
+ <td>Location of the Xrefs to link to.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}/xref</tt>.<br /></td>
</tr>
</table>
</div>
@@ -484,7 +497,7 @@ file before being passed to Checkstyle a
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.config.location}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.config.location</tt></li>
<li><b>Default</b>: <tt>config/sun_checks.xml</tt></li>
</ul><hr /><p><b><a name="consoleOutput">consoleOutput</a>:</b></p>
<div>Output errors to console.</div>
@@ -499,7 +512,7 @@ file before being passed to Checkstyle a
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.enable.files.summary}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.enable.files.summary</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr /><p><b><a name="enableRSS">enableRSS</a>:</b></p>
<div>Specifies if the RSS should be enabled or not.</div>
@@ -507,7 +520,7 @@ file before being passed to Checkstyle a
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.enable.rss}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.enable.rss</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr /><p><b><a name="enableRulesSummary">enableRulesSummary</a>:</b></p>
<div>Specifies if the Rules summary should be enabled or not.</div>
@@ -515,7 +528,7 @@ file before being passed to Checkstyle a
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.enable.rules.summary}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.enable.rules.summary</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr /><p><b><a name="enableSeveritySummary">enableSeveritySummary</a>:</b></p>
<div>Specifies if the Severity summary should be enabled or not.</div>
@@ -523,7 +536,7 @@ file before being passed to Checkstyle a
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.enable.severity.summary}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.enable.severity.summary</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr /><p><b><a name="encoding">encoding</a>:</b></p>
<div>The file encoding to use when reading the source files. If the
@@ -535,7 +548,7 @@ Checkstyle's <tt>TreeWalker</tt> module.
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.2</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${encoding}</tt></li>
+ <li><b>User Property</b>: <tt>encoding</tt></li>
<li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
</ul><hr /><p><b><a name="excludes">excludes</a>:</b></p>
<div>Specifies the names filter of the source files to be excluded for
@@ -544,7 +557,7 @@ Checkstyle.</div>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.excludes}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.excludes</tt></li>
</ul><hr /><p><b><a name="failsOnError">failsOnError</a>:</b></p>
<div>Specifies if the build should fail upon a violation.</div>
<ul>
@@ -570,7 +583,7 @@ correct license header.</div>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${basedir}/LICENSE.txt</tt></li>
+ <li><b>Default</b>: <tt>${basedir}/LICENSE.txt</tt></li>
</ul><hr /><p><b><a name="headerLocation">headerLocation</a>:</b></p>
<div><p>Specifies the location of the License file (a.k.a. the header
file) that can be used by Checkstyle to verify that source code has
@@ -585,7 +598,7 @@ name="headerFile" value="
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.0-beta-2</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.header.file}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.header.file</tt></li>
<li><b>Default</b>: <tt>LICENSE.txt</tt></li>
</ul><hr /><p><b><a name="includeTestSourceDirectory">includeTestSourceDirectory</a>:</b></p>
<div>Include or not the test source directory to be used for Checkstyle.</div>
@@ -593,16 +606,17 @@ name="headerFile" value="
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>2.2</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${false}</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
</ul><hr /><p><b><a name="includes">includes</a>:</b></p>
<div>Specifies the names filter of the source files to be used for
-Checkstyle.</div>
+Checkstyle. <b>Note:</b> default value is
+<tt>**\/*.java</tt>.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.includes}</tt></li>
- <li><b>Default</b>: <tt>**/*.java</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.includes</tt></li>
+ <li><b>Default</b>: <tt>**\/*.java</tt></li>
</ul><hr /><p><b><a name="linkXRef">linkXRef</a>:</b></p>
<div>Link the violation line numbers to the source xref. Will link
automatically if Maven JXR plugin is being used.</div>
@@ -610,7 +624,7 @@ automatically if Maven JXR plugin is bei
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>2.1</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${linkXRef}</tt></li>
+ <li><b>User Property</b>: <tt>linkXRef</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
<div>The output directory for the report. Note that this parameter is
@@ -630,7 +644,7 @@ format of the output file is determined
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.output.file}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.output.file</tt></li>
<li><b>Default</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt></li>
</ul><hr /><p><b><a name="outputFileFormat">outputFileFormat</a>:</b></p>
<div>Specifies the format of the output to be used when writing to the
@@ -639,7 +653,7 @@ output file. Valid values are "plai
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.8</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.output.format}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.output.format</tt></li>
<li><b>Default</b>: <tt>xml</tt></li>
</ul><hr /><p><b><a name="packageNamesFile">packageNamesFile</a>:</b></p>
<div><b>Deprecated.</b> Use packageNamesLocation instead.</div>
@@ -684,7 +698,7 @@ parameter).</p></div>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.0-beta-2</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.properties.location}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.properties.location</tt></li>
</ul><hr /><p><b><a name="propertiesURL">propertiesURL</a>:</b></p>
<div><b>Deprecated.</b> Use propertiesLocation instead.</div>
<div>Specifies the URL of the Checkstyle properties that will be used to
@@ -705,7 +719,7 @@ check the source.</div>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Since</b>: <tt>2.2</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.skip}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.skip</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr /><p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
<div>Specifies the location of the source directory to be used for
@@ -733,7 +747,7 @@ file.</div>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.1</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.suppression.expression}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.suppression.expression</tt></li>
<li><b>Default</b>: <tt>checkstyle.suppressions.file</tt></li>
</ul><hr /><p><b><a name="suppressionsLocation">suppressionsLocation</a>:</b></p>
<div><p>Specifies the location of the suppressions XML file to use.</p>
@@ -748,7 +762,7 @@ that will be made available to your chec
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Since</b>: <tt>2.0-beta-2</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
- <li><b>Expression</b>: <tt>${checkstyle.suppressions.location}</tt></li>
+ <li><b>User Property</b>: <tt>checkstyle.suppressions.location</tt></li>
</ul><hr /><p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
<div>Specifies the location of the test source directory to be used for
Checkstyle.</div>
@@ -776,23 +790,23 @@ violations.</div>
</div>
</div>
-
- </div>
- </div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2005-2012
- The Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- </body>
-</html>
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2013
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
\ No newline at end of file