You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 15:51:05 UTC
svn commit: r816650 [5/23] - in
/websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest:
./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/
apidocs/org/apache/maven/plugin/ apidocs/org/apache/maven/plugin/check...
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/overview-tree.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/overview-tree.html (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/overview-tree.html Tue May 8 13:51:00 2012
@@ -0,0 +1,153 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.4.2_17) on Sat May 31 22:47:35 CEST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+Class Hierarchy (Maven Checkstyle Plugin 2.2 API)
+</TITLE>
+
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="Class Hierarchy (Maven Checkstyle Plugin 2.2 API)";
+}
+</SCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV
+ NEXT</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="overview-tree.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+</FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<CENTER>
+<H2>
+Hierarchy For All Packages</H2>
+</CENTER>
+<DL>
+<DT><B>Package Hierarchies:</B><DD><A HREF="org/apache/maven/plugin/checkstyle/package-tree.html">org.apache.maven.plugin.checkstyle</A></DL>
+<HR>
+<H2>
+Class Hierarchy
+</H2>
+<UL>
+<LI TYPE="circle">class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang"><B>Object</B></A><UL>
+<LI TYPE="circle">class org.apache.maven.plugin.AbstractMojo (implements org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo)
+<UL>
+<LI TYPE="circle">class org.apache.maven.reporting.AbstractMavenReport (implements org.apache.maven.reporting.MavenReport)
+<UL>
+<LI TYPE="circle">class org.apache.maven.plugin.checkstyle.<A HREF="org/apache/maven/plugin/checkstyle/CheckstyleReport.html" title="class in org.apache.maven.plugin.checkstyle"><B>CheckstyleReport</B></A></UL>
+<LI TYPE="circle">class org.apache.maven.plugin.checkstyle.<A HREF="org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html" title="class in org.apache.maven.plugin.checkstyle"><B>CheckstyleViolationCheckMojo</B></A><LI TYPE="circle">class org.apache.maven.plugin.checkstyle.<A HREF="org/apache/maven/plugin/checkstyle/HelpMojo.html" title="class in org.apache.maven.plugin.checkstyle"><B>HelpMojo</B></A></UL>
+<LI TYPE="circle">class com.puppycrawl.tools.checkstyle.api.AutomaticBean (implements com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable)
+<UL>
+<LI TYPE="circle">class org.apache.maven.plugin.checkstyle.<A HREF="org/apache/maven/plugin/checkstyle/CheckstyleReportListener.html" title="class in org.apache.maven.plugin.checkstyle"><B>CheckstyleReportListener</B></A> (implements com.puppycrawl.tools.checkstyle.api.AuditListener)
+</UL>
+<LI TYPE="circle">class org.apache.maven.plugin.checkstyle.<A HREF="org/apache/maven/plugin/checkstyle/CheckstyleReportGenerator.html" title="class in org.apache.maven.plugin.checkstyle"><B>CheckstyleReportGenerator</B></A><LI TYPE="circle">class org.apache.maven.plugin.checkstyle.<A HREF="org/apache/maven/plugin/checkstyle/CheckstyleResults.html" title="class in org.apache.maven.plugin.checkstyle"><B>CheckstyleResults</B></A><LI TYPE="circle">class org.apache.maven.plugin.checkstyle.<A HREF="org/apache/maven/plugin/checkstyle/ReportResource.html" title="class in org.apache.maven.plugin.checkstyle"><B>ReportResource</B></A><LI TYPE="circle">class org.apache.maven.plugin.checkstyle.<A HREF="org/apache/maven/plugin/checkstyle/VelocityTemplate.html" title="class in org.apache.maven.plugin.checkstyle"><B>VelocityTemplate</B></A></UL>
+</UL>
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Tree</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV
+ NEXT</FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="overview-tree.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+</FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright © 2005-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
+</BODY>
+</HTML>
\ No newline at end of file
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/overview-tree.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/overview-tree.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/package-list
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/package-list (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/package-list Tue May 8 13:51:00 2012
@@ -0,0 +1 @@
+org.apache.maven.plugin.checkstyle
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/packages
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/packages (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/packages Tue May 8 13:51:00 2012
@@ -0,0 +1 @@
+org.apache.maven.plugin.checkstyle
\ No newline at end of file
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/packages.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/packages.html (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/packages.html Tue May 8 13:51:00 2012
@@ -0,0 +1,38 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.4.2_17) on Sat May 31 22:47:36 CEST 2008 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+ (Maven Checkstyle Plugin 2.2 API)
+</TITLE>
+
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title=" (Maven Checkstyle Plugin 2.2 API)";
+}
+</SCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+<BR>
+
+<BR>
+
+<BR>
+<CENTER>
+The front page has been relocated.Please see:
+<BR>
+ <A HREF="index.html">Frame version</A>
+<BR>
+ <A HREF="org/apache/maven/plugin/checkstyle/package-summary.html">Non-frame version.</A></CENTER>
+
+</BODY>
+</HTML>
\ No newline at end of file
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/packages.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/packages.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/resources/inherit.gif
==============================================================================
Binary file - no diff available.
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/resources/inherit.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/stylesheet.css
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/stylesheet.css (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/stylesheet.css Tue May 8 13:51:00 2012
@@ -0,0 +1,28 @@
+/* Javadoc style sheet */
+
+/* Define colors, fonts and other style attributes here to override the defaults */
+
+/* Page background color */
+body { background-color: #FFFFFF }
+
+/* Headings */
+h1 { font-size: 145% }
+
+/* Table colors */
+.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 }
+.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;} /* 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;}
+.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/stylesheet.css
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/apidocs/stylesheet.css
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/check-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/check-mojo.html (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/check-mojo.html Tue May 8 13:51:00 2012
@@ -0,0 +1,347 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven Checkstyle Plugin - maven-checkstyle-plugin - checkstyle:check</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+
+<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="http://maven.apache.org/" id="bannerLeft">
+
+ <img src="http://maven.apache.org/images/apache-maven-project-2.png" alt="" />
+
+ </a>
+ <a href="http://maven.apache.org/" id="bannerRight">
+
+ <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
+
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2008-05-31
+ | Version: 2.2
+ </div>
+ <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ |
+ <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
+ |
+ <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
+ |
+ <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
+ |
+ <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
+ |
+ <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
+ |
+ <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
+ |
+ <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
+ |
+ <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
+
+
+
+
+
+
+
+
+ </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>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2><a name="checkstyle:check"></a>
+checkstyle:check</h2>
+<p><strong>Full name</strong>:</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.2:check</p>
+<p><strong>Description</strong>:</p>
+<p>Perform a violation check against the last Checkstyle run to see if
+there are any violations. It reads the Checkstyle output file,
+counts the number of violations found and displays it on the
+console.</p>
+<p><strong>Attributes</strong>:</p>
+<ul><li>Requires a Maven 2.0 project to be executed.</li>
+<li>Requires dependency resolution of artifacts in scope: <code>compile</code>.</li>
+<li>Binds by default to the lifecycle phase: <code>verify</code>.</li>
+<li>Invokes the execution of this plugin's goal <code>checkstyle</code> prior to executing itself.</li>
+</ul>
+<div class="section"><h3><a name="Optional_Parameters"></a>
+Optional Parameters</h3>
+<table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Type</th>
+<th>Since</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><strong><a href="#failOnViolation">failOnViolation</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>-</code></td>
+<td>Do we fail the build on a violation? Default value is: <code>true</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#outputFile">outputFile</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td>Specifies the path and filename to save the Checkstyle output. The
+format of the output file is determined by the
+<code>outputFileFormat</code> parameter. Default value is: <code>${project.build.directory}/checkstyle-result.xml</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#outputFileFormat">outputFileFormat</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td>Specifies the format of the output to be used when writing to the
+output file. Valid values are "plain" and "xml". Default value is: <code>xml</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#skip">skip</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>2.2</code></td>
+<td>Skip entire check. Default value is: <code>false</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#violationSeverity">violationSeverity</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>2.2</code></td>
+<td>The lowest severity level that is considered a violation. Valid
+values are "error", "warning" and "info". Default value is: <code>error</code>.</td>
+</tr>
+</table>
+</div>
+<div class="section"><h3><a name="Parameter_Details"></a>
+Parameter Details</h3>
+<p><strong><a name="failOnViolation">failOnViolation</a>
+:</strong></p>
+<p>Do we fail the build on a violation?</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.failOnViolation}</code></li>
+<li><strong>Default</strong>: <code>true</code></li>
+</ul>
+<hr />
+<p><strong><a name="outputFile">outputFile</a>
+:</strong></p>
+<p>Specifies the path and filename to save the Checkstyle output. The
+format of the output file is determined by the
+<code>outputFileFormat</code> parameter.</p>
+<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.output.file}</code></li>
+<li><strong>Default</strong>: <code>${project.build.directory}/checkstyle-result.xml</code></li>
+</ul>
+<hr />
+<p><strong><a name="outputFileFormat">outputFileFormat</a>
+:</strong></p>
+<p>Specifies the format of the output to be used when writing to the
+output file. Valid values are "plain" and "xml".</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.output.format}</code></li>
+<li><strong>Default</strong>: <code>xml</code></li>
+</ul>
+<hr />
+<p><strong><a name="skip">skip</a>
+:</strong></p>
+<p>Skip entire check.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Since</strong>: <code>2.2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.skip}</code></li>
+<li><strong>Default</strong>: <code>false</code></li>
+</ul>
+<hr />
+<p><strong><a name="violationSeverity">violationSeverity</a>
+:</strong></p>
+<p>The lowest severity level that is considered a violation. Valid
+values are "error", "warning" and "info".</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Since</strong>: <code>2.2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.violationSeverity}</code></li>
+<li><strong>Default</strong>: <code>error</code></li>
+</ul>
+</div>
+</div>
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2005-2008
+
+ 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/check-mojo.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/check-mojo.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-mojo.html (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-mojo.html Tue May 8 13:51:00 2012
@@ -0,0 +1,913 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven Checkstyle Plugin - maven-checkstyle-plugin - checkstyle:checkstyle</title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+
+<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="http://maven.apache.org/" id="bannerLeft">
+
+ <img src="http://maven.apache.org/images/apache-maven-project-2.png" alt="" />
+
+ </a>
+ <a href="http://maven.apache.org/" id="bannerRight">
+
+ <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
+
+ </a>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2008-05-31
+ | Version: 2.2
+ </div>
+ <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ |
+ <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
+ |
+ <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
+ |
+ <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
+ |
+ <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
+ |
+ <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
+ |
+ <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
+ |
+ <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
+ |
+ <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
+
+
+
+
+
+
+
+
+ </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>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2><a name="checkstyle:checkstyle"></a>
+checkstyle:checkstyle</h2>
+<p><strong>Note</strong>: This Mojo should be used as a Maven report.</p>
+<p><strong>Full name</strong>:</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.2:checkstyle</p>
+<p><strong>Description</strong>:</p>
+<p>Perform a Checkstyle analysis, and generate a report on violations.</p>
+<p><strong>Attributes</strong>:</p>
+<ul><li>Requires a Maven 2.0 project to be executed.</li>
+<li>Requires dependency resolution of artifacts in scope: <code>compile</code>.</li>
+</ul>
+<div class="section"><h3><a name="Required_Parameters"></a>
+Required Parameters</h3>
+<table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Type</th>
+<th>Since</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><strong><a href="#includes">includes</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td>Specifies the names filter of the source files to be used for
+Checkstyle. Default value is: <code>**/*.java</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#outputDirectory">outputDirectory</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td>The output directory for the report. Note that this parameter is
+only evaluated if the goal is run directly from the command line.
+If the goal is run indirectly as part of a site generation, the
+output directory configured in Maven Site Plugin is used instead. Default value is: <code>${project.reporting.outputDirectory}</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#sourceDirectory">sourceDirectory</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td>Specifies the location of the source directory to be used for
+Checkstyle. Default value is: <code>${project.build.sourceDirectory}</code>.</td>
+</tr>
+</table>
+</div>
+<div class="section"><h3><a name="Optional_Parameters"></a>
+Optional Parameters</h3>
+<table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Type</th>
+<th>Since</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><strong><a href="#cacheFile">cacheFile</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td>Specifies the cache file used to speed up Checkstyle on successive
+runs. Default value is: <code>${project.build.directory}/checkstyle-cachefile</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#configLocation">configLocation</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td><p>Specifies the location of the XML configuration to use.</p>
+<p>Potential values are a filesystem path, a URL, or a classpath
+resource. This parameter expects that the contents of the location
+conform to the xml format (Checkstyle <a href="http://checkstyle.sourceforge.net/config.html#Modules" class="externalLink">Checker
+module</a>
+) configuration of rulesets.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+successfully resolved, the contents of the configuration is copied
+into the
+<code>${project.build.directory}/checkstyle-configuration.xml</code>
+file before being passed to Checkstyle as a configuration.</p>
+<p>There are 4 predefined rulesets.</p>
+<ul><li><code>config/sun_checks.xml</code>: Sun Checks.</li>
+<li><code>config/turbine_checks.xml</code>: Turbine Checks.</li>
+<li><code>config/avalon_checks.xml</code>: Avalon Checks.</li>
+<li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
+</ul>
+ Default value is: <code>config/sun_checks.xml</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#consoleOutput">consoleOutput</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>-</code></td>
+<td>Output errors to console. Default value is: <code>false</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#enableFilesSummary">enableFilesSummary</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>-</code></td>
+<td>Specifies if the Files summary should be enabled or not. Default value is: <code>true</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#enableRSS">enableRSS</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>-</code></td>
+<td>Specifies if the RSS should be enabled or not. Default value is: <code>true</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#enableRulesSummary">enableRulesSummary</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>-</code></td>
+<td>Specifies if the Rules summary should be enabled or not. Default value is: <code>true</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#enableSeveritySummary">enableSeveritySummary</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>-</code></td>
+<td>Specifies if the Severity summary should be enabled or not. Default value is: <code>true</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#encoding">encoding</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>2.2</code></td>
+<td>The file encoding to use when reading the source files. If the
+property <code>project.build.sourceEncoding</code> is not set, the
+platform default encoding is used. <strong>Note:</strong> This
+parameter always overrides the property <code>charset</code> from
+Checkstyle's <code>TreeWalker</code> module. Default value is: <code>${project.build.sourceEncoding}</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#excludes">excludes</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td>Specifies the names filter of the source files to be excluded for
+Checkstyle. </td>
+</tr>
+<tr class="a"><td><strong><a href="#failsOnError">failsOnError</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>-</code></td>
+<td>Specifies if the build should fail upon a violation. Default value is: <code>false</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#format">format</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td><strong>Deprecated</strong>. Specifies what predefined check set to use. Available sets are
+"sun" (for the Sun coding conventions), "turbine", and "avalon". Default value is: <code>sun</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#headerFile">headerFile</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td><strong>Deprecated</strong>. Specifies the location of the License file (a.k.a. the header file)
+that is used by Checkstyle to verify that source code has the
+correct license header. </td>
+</tr>
+<tr class="b"><td><strong><a href="#headerLocation">headerLocation</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>2.0-beta-2</code></td>
+<td><p>Specifies the location of the License file (a.k.a. the header
+file) that can be used by Checkstyle to verify that source code has
+the correct license header.</p>
+<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
+configuration to reference the name of this header file.</p>
+<p>For instance:</p>
+<p><code><module name="RegexpHeader"> <property
+name="headerFile" value="${checkstyle.header.file}"/>
+</module></code></p>
+ Default value is: <code>LICENSE.txt</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#includeTestSourceDirectory">includeTestSourceDirectory</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>2.2</code></td>
+<td>Include or not the test source directory to be used for Checkstyle. Default value is: <code>${false}</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#linkXRef">linkXRef</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>2.1</code></td>
+<td>Link the violation line numbers to the source xref. Will link
+automatically if Maven JXR plugin is being used. Default value is: <code>true</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#outputFile">outputFile</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td>Specifies the path and filename to save the checkstyle output. The
+format of the output file is determined by the
+<code>outputFileFormat</code> parameter. Default value is: <code>${project.build.directory}/checkstyle-result.xml</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#outputFileFormat">outputFileFormat</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td>Specifies the format of the output to be used when writing to the
+output file. Valid values are "plain" and "xml". Default value is: <code>xml</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#packageNamesFile">packageNamesFile</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td><strong>Deprecated</strong>. Specifies the location of the package names XML to be used to
+configure Checkstyle. </td>
+</tr>
+<tr class="b"><td><strong><a href="#packageNamesLocation">packageNamesLocation</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>2.0-beta-2</code></td>
+<td><p>Specifies the location of the package names XML to be used to
+configure the Checkstyle <a href="http://checkstyle.sourceforge.net/config.html#Packages" class="externalLink">Packages</a>
+.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+resolved to a resource, or a URL, the contents of the package names
+XML is copied into the
+<code>${project.build.directory}/checkstyle-packagenames.xml</code>
+file before being passed to Checkstyle for loading.</p>
+</td>
+</tr>
+<tr class="a"><td><strong><a href="#propertiesFile">propertiesFile</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td><strong>Deprecated</strong>. Specifies the location of the Checkstyle properties file that will
+be used to check the source. </td>
+</tr>
+<tr class="b"><td><strong><a href="#propertiesLocation">propertiesLocation</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>2.0-beta-2</code></td>
+<td><p>Specifies the location of the properties file.</p>
+<p>This parameter is resolved as URL, File then resource. If
+successfully resolved, the contents of the properties location is
+copied into the
+<code>${project.build.directory}/checkstyle-checker.properties</code>
+file before being passed to Checkstyle for loading.</p>
+<p>The contents of the <code>propertiesLocation</code> will be made
+available to Checkstyle for specifying values for parameters within
+the xml configuration (specified in the <code>configLocation</code>
+parameter).</p>
+</td>
+</tr>
+<tr class="a"><td><strong><a href="#propertiesURL">propertiesURL</a>
+</strong></td>
+<td><code>URL</code></td>
+<td><code>-</code></td>
+<td><strong>Deprecated</strong>. Specifies the URL of the Checkstyle properties that will be used to
+check the source. </td>
+</tr>
+<tr class="b"><td><strong><a href="#propertyExpansion">propertyExpansion</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td>Allows for specifying raw property expansion information. </td>
+</tr>
+<tr class="a"><td><strong><a href="#skip">skip</a>
+</strong></td>
+<td><code>boolean</code></td>
+<td><code>2.2</code></td>
+<td>Skip entire check. Default value is: <code>false</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#suppressionsFile">suppressionsFile</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td><strong>Deprecated</strong>. Specifies the location of the suppressions XML file to use. The
+plugin defines a Checkstyle property named
+<code>checkstyle.suppressions.file</code> with the value of this
+property. This allows using the Checkstyle property in your own
+custom checkstyle configuration file when specifying a suppressions
+file. </td>
+</tr>
+<tr class="a"><td><strong><a href="#suppressionsFileExpression">suppressionsFileExpression</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>2.1</code></td>
+<td>The key to be used in the properties for the suppressions file. Default value is: <code>checkstyle.suppressions.file</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#suppressionsLocation">suppressionsLocation</a>
+</strong></td>
+<td><code>String</code></td>
+<td><code>2.0-beta-2</code></td>
+<td><p>Specifies the location of the suppressions XML file to use.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+successfully resolved, the contents of the suppressions XML is
+copied into the
+<code>${project.build.directory}/checkstyle-supressions.xml</code>
+file before being passed to Checkstyle for loading.</p>
+<p>See <code>suppressionsFileExpression</code> for the property
+that will be made available to your checkstyle configuration.</p>
+</td>
+</tr>
+<tr class="a"><td><strong><a href="#testSourceDirectory">testSourceDirectory</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>2.2</code></td>
+<td>Specifies the location of the test source directory to be used for
+Checkstyle. Default value is: <code>${project.build.testSourceDirectory}</code>.</td>
+</tr>
+<tr class="b"><td><strong><a href="#useFile">useFile</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td>If <code>null</code>, the Checkstyle plugin will display violations
+on stdout. Otherwise, a text file will be created with the
+violations. </td>
+</tr>
+<tr class="a"><td><strong><a href="#xrefLocation">xrefLocation</a>
+</strong></td>
+<td><code>File</code></td>
+<td><code>-</code></td>
+<td>Location of the Xrefs to link to. Default value is: <code>${project.reporting.outputDirectory}/xref</code>.</td>
+</tr>
+</table>
+</div>
+<div class="section"><h3><a name="Parameter_Details"></a>
+Parameter Details</h3>
+<p><strong><a name="cacheFile">cacheFile</a>
+:</strong></p>
+<p>Specifies the cache file used to speed up Checkstyle on successive
+runs.</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Default</strong>: <code>${project.build.directory}/checkstyle-cachefile</code></li>
+</ul>
+<hr />
+<p><strong><a name="configLocation">configLocation</a>
+:</strong></p>
+<p><p>Specifies the location of the XML configuration to use.</p>
+<p>Potential values are a filesystem path, a URL, or a classpath
+resource. This parameter expects that the contents of the location
+conform to the xml format (Checkstyle <a href="http://checkstyle.sourceforge.net/config.html#Modules" class="externalLink">Checker
+module</a>
+) configuration of rulesets.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+successfully resolved, the contents of the configuration is copied
+into the
+<code>${project.build.directory}/checkstyle-configuration.xml</code>
+file before being passed to Checkstyle as a configuration.</p>
+<p>There are 4 predefined rulesets.</p>
+<ul><li><code>config/sun_checks.xml</code>: Sun Checks.</li>
+<li><code>config/turbine_checks.xml</code>: Turbine Checks.</li>
+<li><code>config/avalon_checks.xml</code>: Avalon Checks.</li>
+<li><code>config/maven_checks.xml</code>: Maven Source Checks.</li>
+</ul>
+</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.config.location}</code></li>
+<li><strong>Default</strong>: <code>config/sun_checks.xml</code></li>
+</ul>
+<hr />
+<p><strong><a name="consoleOutput">consoleOutput</a>
+:</strong></p>
+<p>Output errors to console.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Default</strong>: <code>false</code></li>
+</ul>
+<hr />
+<p><strong><a name="enableFilesSummary">enableFilesSummary</a>
+:</strong></p>
+<p>Specifies if the Files summary should be enabled or not.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.enable.files.summary}</code></li>
+<li><strong>Default</strong>: <code>true</code></li>
+</ul>
+<hr />
+<p><strong><a name="enableRSS">enableRSS</a>
+:</strong></p>
+<p>Specifies if the RSS should be enabled or not.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.enable.rss}</code></li>
+<li><strong>Default</strong>: <code>true</code></li>
+</ul>
+<hr />
+<p><strong><a name="enableRulesSummary">enableRulesSummary</a>
+:</strong></p>
+<p>Specifies if the Rules summary should be enabled or not.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.enable.rules.summary}</code></li>
+<li><strong>Default</strong>: <code>true</code></li>
+</ul>
+<hr />
+<p><strong><a name="enableSeveritySummary">enableSeveritySummary</a>
+:</strong></p>
+<p>Specifies if the Severity summary should be enabled or not.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.enable.severity.summary}</code></li>
+<li><strong>Default</strong>: <code>true</code></li>
+</ul>
+<hr />
+<p><strong><a name="encoding">encoding</a>
+:</strong></p>
+<p>The file encoding to use when reading the source files. If the
+property <code>project.build.sourceEncoding</code> is not set, the
+platform default encoding is used. <strong>Note:</strong> This
+parameter always overrides the property <code>charset</code> from
+Checkstyle's <code>TreeWalker</code> module.</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Since</strong>: <code>2.2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${encoding}</code></li>
+<li><strong>Default</strong>: <code>${project.build.sourceEncoding}</code></li>
+</ul>
+<hr />
+<p><strong><a name="excludes">excludes</a>
+:</strong></p>
+<p>Specifies the names filter of the source files to be excluded for
+Checkstyle.</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.excludes}</code></li>
+</ul>
+<hr />
+<p><strong><a name="failsOnError">failsOnError</a>
+:</strong></p>
+<p>Specifies if the build should fail upon a violation.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Default</strong>: <code>false</code></li>
+</ul>
+<hr />
+<p><strong><a name="format">format</a>
+:</strong></p>
+<p>Specifies what predefined check set to use. Available sets are
+"sun" (for the Sun coding conventions), "turbine", and "avalon".</p>
+<ul><li><strong>Deprecated</strong>: <code>Use configLocation instead.</code></li>
+<li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Default</strong>: <code>sun</code></li>
+</ul>
+<hr />
+<p><strong><a name="headerFile">headerFile</a>
+:</strong></p>
+<p>Specifies the location of the License file (a.k.a. the header file)
+that is used by Checkstyle to verify that source code has the
+correct license header.</p>
+<ul><li><strong>Deprecated</strong>: <code>Use headerLocation instead.</code></li>
+<li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${basedir}/LICENSE.txt</code></li>
+</ul>
+<hr />
+<p><strong><a name="headerLocation">headerLocation</a>
+:</strong></p>
+<p><p>Specifies the location of the License file (a.k.a. the header
+file) that can be used by Checkstyle to verify that source code has
+the correct license header.</p>
+<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
+configuration to reference the name of this header file.</p>
+<p>For instance:</p>
+<p><code><module name="RegexpHeader"> <property
+name="headerFile" value="${checkstyle.header.file}"/>
+</module></code></p>
+</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Since</strong>: <code>2.0-beta-2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.header.file}</code></li>
+<li><strong>Default</strong>: <code>LICENSE.txt</code></li>
+</ul>
+<hr />
+<p><strong><a name="includeTestSourceDirectory">includeTestSourceDirectory</a>
+:</strong></p>
+<p>Include or not the test source directory to be used for Checkstyle.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Since</strong>: <code>2.2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Default</strong>: <code>${false}</code></li>
+</ul>
+<hr />
+<p><strong><a name="includes">includes</a>
+:</strong></p>
+<p>Specifies the names filter of the source files to be used for
+Checkstyle.</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>Yes</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.includes}</code></li>
+<li><strong>Default</strong>: <code>**/*.java</code></li>
+</ul>
+<hr />
+<p><strong><a name="linkXRef">linkXRef</a>
+:</strong></p>
+<p>Link the violation line numbers to the source xref. Will link
+automatically if Maven JXR plugin is being used.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Since</strong>: <code>2.1</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${linkXRef}</code></li>
+<li><strong>Default</strong>: <code>true</code></li>
+</ul>
+<hr />
+<p><strong><a name="outputDirectory">outputDirectory</a>
+:</strong></p>
+<p>The output directory for the report. Note that this parameter is
+only evaluated if the goal is run directly from the command line.
+If the goal is run indirectly as part of a site generation, the
+output directory configured in Maven Site Plugin is used instead.</p>
+<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>Yes</code></li>
+<li><strong>Default</strong>: <code>${project.reporting.outputDirectory}</code></li>
+</ul>
+<hr />
+<p><strong><a name="outputFile">outputFile</a>
+:</strong></p>
+<p>Specifies the path and filename to save the checkstyle output. The
+format of the output file is determined by the
+<code>outputFileFormat</code> parameter.</p>
+<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.output.file}</code></li>
+<li><strong>Default</strong>: <code>${project.build.directory}/checkstyle-result.xml</code></li>
+</ul>
+<hr />
+<p><strong><a name="outputFileFormat">outputFileFormat</a>
+:</strong></p>
+<p>Specifies the format of the output to be used when writing to the
+output file. Valid values are "plain" and "xml".</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.output.format}</code></li>
+<li><strong>Default</strong>: <code>xml</code></li>
+</ul>
+<hr />
+<p><strong><a name="packageNamesFile">packageNamesFile</a>
+:</strong></p>
+<p>Specifies the location of the package names XML to be used to
+configure Checkstyle.</p>
+<ul><li><strong>Deprecated</strong>: <code>Use packageNamesLocation instead.</code></li>
+<li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+</ul>
+<hr />
+<p><strong><a name="packageNamesLocation">packageNamesLocation</a>
+:</strong></p>
+<p><p>Specifies the location of the package names XML to be used to
+configure the Checkstyle <a href="http://checkstyle.sourceforge.net/config.html#Packages" class="externalLink">Packages</a>
+.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+resolved to a resource, or a URL, the contents of the package names
+XML is copied into the
+<code>${project.build.directory}/checkstyle-packagenames.xml</code>
+file before being passed to Checkstyle for loading.</p>
+</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Since</strong>: <code>2.0-beta-2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+</ul>
+<hr />
+<p><strong><a name="propertiesFile">propertiesFile</a>
+:</strong></p>
+<p>Specifies the location of the Checkstyle properties file that will
+be used to check the source.</p>
+<ul><li><strong>Deprecated</strong>: <code>Use propertiesLocation instead.</code></li>
+<li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+</ul>
+<hr />
+<p><strong><a name="propertiesLocation">propertiesLocation</a>
+:</strong></p>
+<p><p>Specifies the location of the properties file.</p>
+<p>This parameter is resolved as URL, File then resource. If
+successfully resolved, the contents of the properties location is
+copied into the
+<code>${project.build.directory}/checkstyle-checker.properties</code>
+file before being passed to Checkstyle for loading.</p>
+<p>The contents of the <code>propertiesLocation</code> will be made
+available to Checkstyle for specifying values for parameters within
+the xml configuration (specified in the <code>configLocation</code>
+parameter).</p>
+</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Since</strong>: <code>2.0-beta-2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.properties.location}</code></li>
+</ul>
+<hr />
+<p><strong><a name="propertiesURL">propertiesURL</a>
+:</strong></p>
+<p>Specifies the URL of the Checkstyle properties that will be used to
+check the source.</p>
+<ul><li><strong>Deprecated</strong>: <code>Use propertiesLocation instead.</code></li>
+<li><strong>Type</strong>: <code>java.net.URL</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+</ul>
+<hr />
+<p><strong><a name="propertyExpansion">propertyExpansion</a>
+:</strong></p>
+<p>Allows for specifying raw property expansion information.</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+</ul>
+<hr />
+<p><strong><a name="skip">skip</a>
+:</strong></p>
+<p>Skip entire check.</p>
+<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Since</strong>: <code>2.2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.skip}</code></li>
+<li><strong>Default</strong>: <code>false</code></li>
+</ul>
+<hr />
+<p><strong><a name="sourceDirectory">sourceDirectory</a>
+:</strong></p>
+<p>Specifies the location of the source directory to be used for
+Checkstyle.</p>
+<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>Yes</code></li>
+<li><strong>Default</strong>: <code>${project.build.sourceDirectory}</code></li>
+</ul>
+<hr />
+<p><strong><a name="suppressionsFile">suppressionsFile</a>
+:</strong></p>
+<p>Specifies the location of the suppressions XML file to use. The
+plugin defines a Checkstyle property named
+<code>checkstyle.suppressions.file</code> with the value of this
+property. This allows using the Checkstyle property in your own
+custom checkstyle configuration file when specifying a suppressions
+file.</p>
+<ul><li><strong>Deprecated</strong>: <code>Use suppressionsLocation instead.</code></li>
+<li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+</ul>
+<hr />
+<p><strong><a name="suppressionsFileExpression">suppressionsFileExpression</a>
+:</strong></p>
+<p>The key to be used in the properties for the suppressions file.</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Since</strong>: <code>2.1</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.suppression.expression}</code></li>
+<li><strong>Default</strong>: <code>checkstyle.suppressions.file</code></li>
+</ul>
+<hr />
+<p><strong><a name="suppressionsLocation">suppressionsLocation</a>
+:</strong></p>
+<p><p>Specifies the location of the suppressions XML file to use.</p>
+<p>This parameter is resolved as resource, URL, then file. If
+successfully resolved, the contents of the suppressions XML is
+copied into the
+<code>${project.build.directory}/checkstyle-supressions.xml</code>
+file before being passed to Checkstyle for loading.</p>
+<p>See <code>suppressionsFileExpression</code> for the property
+that will be made available to your checkstyle configuration.</p>
+</p>
+<ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Since</strong>: <code>2.0-beta-2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${checkstyle.suppressions.location}</code></li>
+</ul>
+<hr />
+<p><strong><a name="testSourceDirectory">testSourceDirectory</a>
+:</strong></p>
+<p>Specifies the location of the test source directory to be used for
+Checkstyle.</p>
+<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Since</strong>: <code>2.2</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Default</strong>: <code>${project.build.testSourceDirectory}</code></li>
+</ul>
+<hr />
+<p><strong><a name="useFile">useFile</a>
+:</strong></p>
+<p>If <code>null</code>, the Checkstyle plugin will display violations
+on stdout. Otherwise, a text file will be created with the
+violations.</p>
+<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+</ul>
+<hr />
+<p><strong><a name="xrefLocation">xrefLocation</a>
+:</strong></p>
+<p>Location of the Xrefs to link to.</p>
+<ul><li><strong>Type</strong>: <code>java.io.File</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Default</strong>: <code>${project.reporting.outputDirectory}/xref</code></li>
+</ul>
+</div>
+</div>
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2005-2008
+
+ 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-mojo.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/checkstyle-mojo.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision