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 16:02:13 UTC
svn commit: r816667 [8/27] - in
/websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest:
./ apidocs/ apidocs/org/apache/maven/plugin/checkstyle/
apidocs/org/apache/maven/plugin/checkstyle/class-use/
apidocs/org/apache/maven/plugin...
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/serialized-form.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/serialized-form.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/serialized-form.html Tue May 8 14:02:08 2012
@@ -2,22 +2,19 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_23) on Mon Aug 08 20:38:36 CEST 2011 -->
+<!-- Generated by javadoc (build 1.5.0_22) on Mon Oct 24 11:45:35 BST 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-Serialized Form (Maven Checkstyle Plugin 2.7 API)
+Serialized Form (Maven Checkstyle Plugin 2.8 API)
</TITLE>
-<META NAME="date" CONTENT="2011-08-08">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Serialized Form (Maven Checkstyle Plugin 2.7 API)";
- }
+ parent.document.title="Serialized Form (Maven Checkstyle Plugin 2.8 API)";
}
</SCRIPT>
<NOSCRIPT>
@@ -26,7 +23,6 @@ function windowTitle()
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
-<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
@@ -98,7 +94,7 @@ Serialized Form</H1>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Class <A HREF="org/apache/maven/plugin/checkstyle/CheckstyleExecutorException.html" title="class in org.apache.maven.plugin.checkstyle">org.apache.maven.plugin.checkstyle.CheckstyleExecutorException</A> extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A> implements Serializable</B></FONT></TH>
+<B>Class <A HREF="org/apache/maven/plugin/checkstyle/CheckstyleExecutorException.html" title="class in org.apache.maven.plugin.checkstyle">org.apache.maven.plugin.checkstyle.CheckstyleExecutorException</A> extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A> implements Serializable</B></FONT></TH>
</TR>
</TABLE>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/stylesheet.css
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/stylesheet.css (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/stylesheet.css Tue May 8 14:02:08 2012
@@ -3,26 +3,26 @@
/* Define colors, fonts and other style attributes here to override the defaults */
/* Page background color */
-body { background-color: #FFFFFF; color:#000000 }
+body { background-color: #FFFFFF }
/* Headings */
h1 { font-size: 145% }
/* Table colors */
-.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */
-.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */
-.TableRowColor { background: #FFFFFF; color:#000000 } /* White */
+.TableHeadingColor { background: #CCCCFF } /* Dark mauve */
+.TableSubHeadingColor { background: #EEEEFF } /* Light mauve */
+.TableRowColor { background: #FFFFFF } /* White */
/* Font used in left-hand frame lists */
-.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 }
-.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 }
-.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 }
+.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif }
+.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
+.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
/* Navigation bar fonts and colors */
-.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */
-.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */
-.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;}
-.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;}
+.NavBarCell1 { background-color:#EEEEFF;} /* Light mauve */
+.NavBarCell1Rev { background-color:#00008B;} /* Dark Blue */
+.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;}
+.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
-.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
-.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
+.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
+.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
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 14:02:08 2012
@@ -1,8 +1,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 Aug 8, 2011 -->
+<!-- Generated by Apache Maven Doxia at Oct 24, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Checkstyle Plugin -
+ <title>
checkstyle:check</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@@ -10,10 +10,10 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20110808" />
+ <meta name="Date-Revision-yyyymmdd" content="20111024" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
<script type="text/javascript">_uacct = "UA-140879-1";
urchinTracker();</script>
@@ -39,14 +39,14 @@
>
<a href="../index.html">Plugins</a>
>
- <a href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" class="externalLink">Maven Checkstyle Plugin</a>
+ <a href="./">Maven Checkstyle Plugin</a>
>
- Maven Checkstyle Plugin -
+
checkstyle:check
</div>
<div class="xright">
- Last Published: 2011-08-08
- | Version: 2.7
+ Last Published: 2011-10-24
+ | Version: 2.8
</div>
<div class="clear">
<hr/>
@@ -93,7 +93,7 @@
<li class="collapsed">
<a href="project-info.html">Project Information</a>
</li>
- <li class="collapsed">
+ <li class="collapsed">
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
@@ -145,7 +145,7 @@
<div class="section"><h2>checkstyle:check<a name="checkstyle:check"></a></h2>
<p><b>Full name</b>:</p>
- <p>org.apache.maven.plugins:maven-checkstyle-plugin:2.7:check</p>
+ <p>org.apache.maven.plugins:maven-checkstyle-plugin:2.8:check</p>
<p><b>Description</b>:</p>
<div>Perform a violation check against the last Checkstyle run to see if
there are any violations. It reads the Checkstyle output file,
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-aggregate-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-aggregate-mojo.html (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-aggregate-mojo.html Tue May 8 14:02:08 2012
@@ -0,0 +1,670 @@
+<!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 Oct 24, 2011 -->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>
+ 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="20111024" />
+ <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">_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-aggregate
+ </div>
+ <div class="xright">
+ Last Published: 2011-10-24
+ | Version: 2.8
+ </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</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>
+ <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-aggregate<a name="checkstyle:checkstyle-aggregate"></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.8:checkstyle-aggregate</p>
+ <p><b>Description</b>:</p>
+ <div>Perform a Checkstyle analysis, and generate a report on violations,
+aggregating the result in the project which started this mojo.</div>
+ <p><b>Attributes</b>:</p>
+ <ul>
+ <li>Requires a Maven project to be executed.</li>
+ <li>Executes as an aggregator plugin.</li>
+ <li>Requires dependency resolution of artifacts in scope: <tt>compile</tt>.</li>
+ <li>The goal is thread-safe and supports parallel builds.</li>
+ <li>Since version: <tt>2.8</tt>.</li>
+ </ul>
+ <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
+ <table class="bodyTable" border="0">
+ <tr class="a">
+ <th>Name</th>
+ <th>Type</th>
+ <th>Since</th>
+ <th>Description</th>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#includes">includes</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>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>
+ </tr>
+ <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>.</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>
+ </tr>
+ </table>
+ </div>
+ <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+ <table class="bodyTable" border="0">
+ <tr class="a">
+ <th>Name</th>
+ <th>Type</th>
+ <th>Since</th>
+ <th>Description</th>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#cacheFile">cacheFile</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>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>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#configLocation">configLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.8</tt></td>
+ <td><p>Specifies the location of the XML configuration to use.</p>
+<p>Potential values are a filesystem path, a URL, or a classpath
+resource. This parameter expects that the contents of the location
+conform to the xml format (Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Modules">Checker
+module</a>) configuration of rulesets.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+successfully resolved, the contents of the configuration is copied
+into the
+<tt>${project.build.directory}/checkstyle-configuration.xml</tt>
+file before being passed to Checkstyle as a configuration.</p>
+<p>There are 4 predefined rulesets.</p>
+<ul>
+<li><tt>config/sun_checks.xml</tt>: Sun Checks.</li>
+<li><tt>config/turbine_checks.xml</tt>: Turbine Checks.</li>
+<li><tt>config/avalon_checks.xml</tt>: Avalon Checks.</li>
+<li><tt>config/maven_checks.xml</tt>: Maven Source Checks.</li>
+</ul><br /><b>Default value is</b>: <tt>config/sun_checks.xml</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#consoleOutput">consoleOutput</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.8</tt></td>
+ <td>Output errors to console.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#enableFilesSummary">enableFilesSummary</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>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>
+ </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>
+ </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>
+ </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>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#encoding">encoding</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.2</tt></td>
+ <td>The file encoding to use when reading the source files. If the
+property <tt>project.build.sourceEncoding</tt> is not set, the
+platform default encoding is used. <b>Note:</b> This
+parameter always overrides the property <tt>charset</tt> from
+Checkstyle's <tt>TreeWalker</tt> module.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#excludes">excludes</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.8</tt></td>
+ <td>Specifies the names filter of the source files to be excluded for
+Checkstyle.<br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#failsOnError">failsOnError</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.8</tt></td>
+ <td>Specifies if the build should fail upon a violation.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#headerLocation">headerLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.0-beta-2</tt></td>
+ <td><p>Specifies the location of the License file (a.k.a. the header
+file) that can be used by Checkstyle to verify that source code has
+the correct license header.</p>
+<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
+configuration to reference the name of this header file.</p>
+<p>For instance:</p>
+<p><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>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#includeTestSourceDirectory">includeTestSourceDirectory</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.2</tt></td>
+ <td>Include or not the test source directory to be used for Checkstyle.<br /><b>Default value is</b>: <tt>${false}</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#linkXRef">linkXRef</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.1</tt></td>
+ <td>Link the violation line numbers to the source xref. Will link
+automatically if Maven JXR plugin is being used.<br /><b>Default value is</b>: <tt>true</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#outputFile">outputFile</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>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>
+ </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>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#propertiesLocation">propertiesLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.0-beta-2</tt></td>
+ <td><p>Specifies the location of the properties file.</p>
+<p>This parameter is resolved as URL, File then resource. If
+successfully resolved, the contents of the properties location is
+copied into the
+<tt>${project.build.directory}/checkstyle-checker.properties</tt>
+file before being passed to Checkstyle for loading.</p>
+<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>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#propertyExpansion">propertyExpansion</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.8</tt></td>
+ <td>Allows for specifying raw property expansion information.<br /></td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#skip">skip</a></b></td>
+ <td><tt>boolean</tt></td>
+ <td><tt>2.2</tt></td>
+ <td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td><b><a href="#suppressionsFileExpression">suppressionsFileExpression</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.1</tt></td>
+ <td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <tt>checkstyle.suppressions.file</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#suppressionsLocation">suppressionsLocation</a></b></td>
+ <td><tt>String</tt></td>
+ <td><tt>2.0-beta-2</tt></td>
+ <td><p>Specifies the location of the suppressions XML file to use.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+successfully resolved, the contents of the suppressions XML is
+copied into the
+<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>
+ </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>.</td>
+ </tr>
+ <tr class="a">
+ <td><b><a href="#useFile">useFile</a></b></td>
+ <td><tt>File</tt></td>
+ <td><tt>2.8</tt></td>
+ <td>If <tt>null</tt>, the Checkstyle plugin will display violations
+on stdout. Otherwise, a text file will be created with the
+violations.<br /></td>
+ </tr>
+ <tr class="b">
+ <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>
+ </tr>
+ </table>
+ </div>
+ <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
+ <p><b><a name="cacheFile">cacheFile</a>:</b></p>
+ <div>Specifies the cache file used to speed up Checkstyle on successive
+runs.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.8</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${project.build.directory}/checkstyle-cachefile</tt></li>
+ </ul><hr /><p><b><a name="configLocation">configLocation</a>:</b></p>
+ <div><p>Specifies the location of the XML configuration to use.</p>
+<p>Potential values are a filesystem path, a URL, or a classpath
+resource. This parameter expects that the contents of the location
+conform to the xml format (Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Modules">Checker
+module</a>) configuration of rulesets.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+successfully resolved, the contents of the configuration is copied
+into the
+<tt>${project.build.directory}/checkstyle-configuration.xml</tt>
+file before being passed to Checkstyle as a configuration.</p>
+<p>There are 4 predefined rulesets.</p>
+<ul>
+<li><tt>config/sun_checks.xml</tt>: Sun Checks.</li>
+<li><tt>config/turbine_checks.xml</tt>: Turbine Checks.</li>
+<li><tt>config/avalon_checks.xml</tt>: Avalon Checks.</li>
+<li><tt>config/maven_checks.xml</tt>: Maven Source Checks.</li>
+</ul></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>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>Default</b>: <tt>config/sun_checks.xml</tt></li>
+ </ul><hr /><p><b><a name="consoleOutput">consoleOutput</a>:</b></p>
+ <div>Output errors to console.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.8</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="enableFilesSummary">enableFilesSummary</a>:</b></p>
+ <div>Specifies if the Files summary should be enabled or not.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>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>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="enableRSS">enableRSS</a>:</b></p>
+ <div>Specifies if the RSS should be enabled or not.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>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>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="enableRulesSummary">enableRulesSummary</a>:</b></p>
+ <div>Specifies if the Rules summary should be enabled or not.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>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>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="enableSeveritySummary">enableSeveritySummary</a>:</b></p>
+ <div>Specifies if the Severity summary should be enabled or not.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>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>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="encoding">encoding</a>:</b></p>
+ <div>The file encoding to use when reading the source files. If the
+property <tt>project.build.sourceEncoding</tt> is not set, the
+platform default encoding is used. <b>Note:</b> This
+parameter always overrides the property <tt>charset</tt> from
+Checkstyle's <tt>TreeWalker</tt> module.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${encoding}</tt></li>
+ <li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
+ </ul><hr /><p><b><a name="excludes">excludes</a>:</b></p>
+ <div>Specifies the names filter of the source files to be excluded for
+Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.8</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.excludes}</tt></li>
+ </ul><hr /><p><b><a name="failsOnError">failsOnError</a>:</b></p>
+ <div>Specifies if the build should fail upon a violation.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.8</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="headerLocation">headerLocation</a>:</b></p>
+ <div><p>Specifies the location of the License file (a.k.a. the header
+file) that can be used by Checkstyle to verify that source code has
+the correct license header.</p>
+<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
+configuration to reference the name of this header file.</p>
+<p>For instance:</p>
+<p><tt><module name="RegexpHeader"> <property
+name="headerFile" value="${checkstyle.header.file}"/>
+</module></tt></p></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.header.file}</tt></li>
+ <li><b>Default</b>: <tt>LICENSE.txt</tt></li>
+ </ul><hr /><p><b><a name="includeTestSourceDirectory">includeTestSourceDirectory</a>:</b></p>
+ <div>Include or not the test source directory to be used for Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${false}</tt></li>
+ </ul><hr /><p><b><a name="includes">includes</a>:</b></p>
+ <div>Specifies the names filter of the source files to be used for
+Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>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>
+ </ul><hr /><p><b><a name="linkXRef">linkXRef</a>:</b></p>
+ <div>Link the violation line numbers to the source xref. Will link
+automatically if Maven JXR plugin is being used.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.1</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${linkXRef}</tt></li>
+ <li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
+ <div>The output directory for the report. Note that this parameter is
+only evaluated if the goal is run directly from the command line.
+If the goal is run indirectly as part of a site generation, the
+output directory configured in Maven Site Plugin is used instead.</div>
+ <ul>
+ <li><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
+format of the output file is determined by the
+<tt>outputFileFormat</tt> parameter.</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>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.output.file}</tt></li>
+ <li><b>Default</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt></li>
+ </ul><hr /><p><b><a name="outputFileFormat">outputFileFormat</a>:</b></p>
+ <div>Specifies the format of the output to be used when writing to the
+output file. Valid values are "plain" and "xml".</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>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>Default</b>: <tt>xml</tt></li>
+ </ul><hr /><p><b><a name="propertiesLocation">propertiesLocation</a>:</b></p>
+ <div><p>Specifies the location of the properties file.</p>
+<p>This parameter is resolved as URL, File then resource. If
+successfully resolved, the contents of the properties location is
+copied into the
+<tt>${project.build.directory}/checkstyle-checker.properties</tt>
+file before being passed to Checkstyle for loading.</p>
+<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></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.properties.location}</tt></li>
+ </ul><hr /><p><b><a name="propertyExpansion">propertyExpansion</a>:</b></p>
+ <div>Allows for specifying raw property expansion information.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.8</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr /><p><b><a name="skip">skip</a>:</b></p>
+ <div>Skip entire check.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Since</b>: <tt>2.2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.skip}</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
+ <div>Specifies the location of the source directory to be used for
+Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>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>
+ </ul><hr /><p><b><a name="suppressionsFileExpression">suppressionsFileExpression</a>:</b></p>
+ <div>The key to be used in the properties for the suppressions file.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.1</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.suppression.expression}</tt></li>
+ <li><b>Default</b>: <tt>checkstyle.suppressions.file</tt></li>
+ </ul><hr /><p><b><a name="suppressionsLocation">suppressionsLocation</a>:</b></p>
+ <div><p>Specifies the location of the suppressions XML file to use.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+successfully resolved, the contents of the suppressions XML is
+copied into the
+<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></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Expression</b>: <tt>${checkstyle.suppressions.location}</tt></li>
+ </ul><hr /><p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
+ <div>Specifies the location of the test source directory to be used for
+Checkstyle.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Since</b>: <tt>2.2</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${project.build.testSourceDirectory}</tt></li>
+ </ul><hr /><p><b><a name="useFile">useFile</a>:</b></p>
+ <div>If <tt>null</tt>, the Checkstyle plugin will display violations
+on stdout. Otherwise, a text file will be created with the
+violations.</div>
+ <ul>
+ <li><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>
+ </ul><hr /><p><b><a name="xrefLocation">xrefLocation</a>:</b></p>
+ <div>Location of the Xrefs to link to.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.io.File</tt></li>
+ <li><b>Since</b>: <tt>2.8</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${project.reporting.outputDirectory}/xref</tt></li>
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2005-2011
+ 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
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-aggregate-mojo.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-aggregate-mojo.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision