You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 15:52:36 UTC
svn commit: r816652 [12/21] - in
/websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest:
./ apidocs/ apidocs/org/apache/maven/plugin/checkstyle/
apidocs/org/apache/maven/plugin/checkstyle/class-use/ cobertura/ css/
examples/ imag...
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-checker-config.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-checker-config.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-checker-config.html Tue May 8 13:52:31 2012
@@ -20,7 +20,7 @@
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
<meta name="author" content="July 2006" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -160,6 +154,10 @@
+
+
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -193,6 +191,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
+ </li>
+ </ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
</a>
@@ -209,10 +254,8 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Using a Custom Checkstyle Checker Configuration</h2>
-<p>A custom <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Checker">Checker configuration xml file</a>
- can be defined and then referenced via a URL, File, or build classpath resource reference.</p>
-<p>To reference a custom Checkstyle Checker configuration, use the <b>configLocation</b>
- parameter.</p>
+<p>A custom <a href="http://checkstyle.sourceforge.net/config.html#Checker" class="externalLink">Checker configuration xml file</a> can be defined and then referenced via a URL, File, or build classpath resource reference.</p>
+<p>To reference a custom Checkstyle Checker configuration, use the <tt>configLocation</tt> parameter.</p>
<div class="source"><pre><project>
...
<reporting>
@@ -220,6 +263,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
</configuration>
@@ -230,18 +274,12 @@
</project>
</pre>
</div>
-<p>This example causes the Checkstyle plugin to check for a File named <tt>checkstyle.xml</tt>
- or a resource named <tt>checkstyle.xml</tt>
- within the compile scope of the dependencies or build extensions classpath.</p>
-<p>There are 4 predefined Checkstyle configuration definitions that ship with the Checkstyle plugin, the Sun Microsystems Definition is selected by default.</p>
-<ul><li><b>config/sun_checks.xml</b>
- - Sun Microsystems Definition (default).</li>
-<li><b>config/maven_checks.xml</b>
- - Maven Development Definitions.</li>
-<li><b>config/turbine_checks.xml</b>
- - Turbine Development Definitions.</li>
-<li><b>config/avalon_checks.xml</b>
- - Avalon Development Definitions.</li>
+<p>This example causes the Checkstyle Plugin to check for a File named <tt>checkstyle.xml</tt> or a resource named <tt>checkstyle.xml</tt> within the compile scope of the dependencies or build extensions classpath.</p>
+<p>There are 4 predefined Checkstyle configuration definitions that ship with the Checkstyle Plugin, the Sun Microsystems Definition is selected by default.</p>
+<ul><li><b>config/sun_checks.xml</b> - Sun Microsystems Definition (default).</li>
+<li><b>config/maven_checks.xml</b> - Maven Development Definitions.</li>
+<li><b>config/turbine_checks.xml</b> - Turbine Development Definitions.</li>
+<li><b>config/avalon_checks.xml</b> - Avalon Development Definitions.</li>
</ul>
</div>
@@ -252,7 +290,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -263,7 +301,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-developed-checkstyle.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-developed-checkstyle.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-developed-checkstyle.html Tue May 8 13:52:31 2012
@@ -20,7 +20,7 @@
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
<meta name="author" content="2008-02-04" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -160,6 +154,10 @@
+
+
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -193,6 +191,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
+ </li>
+ </ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
</a>
@@ -209,11 +254,9 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Using Custom Developed Checkstyle Checks</h2>
-<p>We will guide you through creating a Maven project that produces a jar file of your custom checks. Then we'll include it in one of your projects by adding it as a dependency to the Checkstyle plugin.</p>
-<p>The plugin also provides the ability to define the <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Packages">package names XML document</a>
- required to reference your custom check modules more easily.</p>
-<p>In this example we will be using the <a class="externalLink" href="http://checkstyle.sourceforge.net/writingchecks.html#Visitor%20in%20action">example check</a>
- that can be found on the Checkstyle web site.</p>
+<p>We will guide you through creating a Maven project that produces a jar file of your custom checks. Then we'll include it in one of your projects by adding it as a dependency to the Checkstyle Plugin.</p>
+<p>The plugin also provides the ability to define the <a href="http://checkstyle.sourceforge.net/config.html#Packages" class="externalLink">package names XML document</a> required to reference your custom check modules more easily.</p>
+<p>In this example we will be using the <a href="http://checkstyle.sourceforge.net/writingchecks.html#Visitor%20in%20action" class="externalLink">example check</a> that can be found on the Checkstyle web site.</p>
<div class="section"><h3>Structuring your project</h3>
<p>First we set up the directory structure for the custom ckecks project. It looks like this:</p>
<div class="source"><pre>mycompany-checkstyle-checks
@@ -229,8 +272,7 @@
</pre>
</div>
<p>Now we'll go through each of the three files one at a time.</p>
-<div class="section"><h4><tt>pom.xml</tt>
-</h4>
+<div class="section"><h4><tt>pom.xml</tt></h4>
<p>Not much to say here, except that we add a dependency on Checkstyle.</p>
<div class="source"><pre><project>
<modelVersion>4.0.0</modelVersion>
@@ -242,17 +284,15 @@
<dependency>
<groupId>checkstyle</groupId>
<artifactId>checkstyle</artifactId>
- <version>4.3</version>
+ <version>4.4</version>
</dependency>
</dependencies>
</project>
</pre>
</div>
</div>
-<div class="section"><h4><tt>packagenames.xml</tt>
-</h4>
-<p>This file lets you specify the names of the packages that you want to be able to use. Here we have added <tt>com.mycompany.checks</tt>
- to the standard set of Checkstyle packages. That means that you can use your custom checks in the Checkstyle configuration file, without having to specify their package name.</p>
+<div class="section"><h4><tt>packagenames.xml</tt></h4>
+<p>This file lets you specify the names of the packages that you want to be able to use. Here we have added <tt>com.mycompany.checks</tt> to the standard set of Checkstyle packages. That means that you can use your custom checks in the Checkstyle configuration file, without having to specify their package name.</p>
<div class="source"><pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE checkstyle-packages PUBLIC
@@ -284,8 +324,7 @@
</pre>
</div>
</div>
-<div class="section"><h4><tt>MethodLimitCheck.java</tt>
-</h4>
+<div class="section"><h4><tt>MethodLimitCheck.java</tt></h4>
<p>Here is the example check from the Checkstyle site. It checks that your source files don't have more that 30 methods.</p>
<div class="source"><pre>package com.mycompany.checks;
import com.puppycrawl.tools.checkstyle.api.*;
@@ -317,14 +356,13 @@ public class MethodLimitCheck extends Ch
</div>
</div>
</div>
-<div class="section"><h3>Building a jar for your custom checks project</h3>
+<div class="section"><h3>Building a JAR for your custom checks project</h3>
<p>To be able to use your custom checks in other projects, you need to package and install them. To do that, just run this on the command line:</p>
<div class="source"><pre>mvn install
</pre>
</div>
-<p>This produces a jar file with the following contents and installs it into your local repository.</p>
-<div class="section"><h4><tt>mycompany-checkstyle-checks-1.0.jar</tt>
-.</h4>
+<p>This produces a JAR file with the following contents and installs it into your local repository.</p>
+<div class="section"><h4><tt>mycompany-checkstyle-checks-1.0.jar</tt></h4>
<div class="source"><pre>mycompany-checkstyle-checks-1.0.jar
|-- pom.xml
|-- META-INF
@@ -346,11 +384,8 @@ public class MethodLimitCheck extends Ch
<div class="section"><h3>Using your checks in another project</h3>
<p>Now you are ready to make use of your custom checks in another project.</p>
<div class="section"><h4>Create a Checkstyle configuration</h4>
-<p>Create the file <tt>checkstyle.xml</tt>
- in the root of the project that wants to use your custom checks. In this file you tell Checkstyle which checks you want to use.</p>
-<p><b>Note:</b>
- We don't have to specify the fully qualified classname of our check here. That's because we used the <tt>packagenames.xml</tt>
- file earlier.</p>
+<p>Create the file <tt>checkstyle.xml</tt> in the root of the project that wants to use your custom checks. In this file you tell Checkstyle which checks you want to use.</p>
+<p><b>Note:</b> We don't have to specify the fully qualified classname of our check here. That's because we used the <tt>packagenames.xml</tt> file earlier.</p>
<div class="source"><pre><?xml version="1.0" ?>
<!DOCTYPE module PUBLIC
@@ -365,17 +400,9 @@ public class MethodLimitCheck extends Ch
</pre>
</div>
</div>
-<div class="section"><h4>Configure the Checkstyle plugin to use your custom checks</h4>
-<p>Finally we need to tell the other project that you want it to use your custom Checkstyle checks. In the <tt>pom.xml</tt>
- of that project, add the following configuration.</p>
-<p><b>Note:</b>
- You have to specify a plugin dependency on <i>mycompany-checkstyle-checks</i>
- in the <tt><build></tt>
- element of your <tt>pom.xml</tt>
-. It will not work inside the <tt><reporting></tt>
- element, because <tt><reporting></tt>
- does not support plugin dependencies. The rest of the configuration is done in the normal way in the <tt><reporting></tt>
- element.</p>
+<div class="section"><h4>Configure the Checkstyle Plugin to use your custom checks</h4>
+<p>Finally we need to tell the other project that you want it to use your custom Checkstyle checks. In the <tt>pom.xml</tt> of that project, add the following configuration.</p>
+<p><b>Note:</b> You have to specify a plugin dependency on <tt>mycompany-checkstyle-checks</tt> in the <tt><build></tt> element of your <tt>pom.xml</tt>. It will not work inside the <tt><reporting></tt> element, because <tt><reporting></tt> does not support plugin dependencies. The rest of the configuration is done in the normal way in the <tt><reporting></tt> element.</p>
<div class="source"><pre><project>
...
<build>
@@ -383,6 +410,7 @@ public class MethodLimitCheck extends Ch
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.3</version>
<dependencies>
<dependency>
<groupId>com.mycompany</groupId>
@@ -398,6 +426,7 @@ public class MethodLimitCheck extends Ch
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<packageNamesLocation>com/mycompany/checks/packagenames.xml</packageNamesLocation>
@@ -420,7 +449,7 @@ public class MethodLimitCheck extends Ch
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -431,7 +460,7 @@ public class MethodLimitCheck extends Ch
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-property-expansion.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-property-expansion.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/custom-property-expansion.html Tue May 8 13:52:31 2012
@@ -20,7 +20,7 @@
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
<meta name="author" content="July 2006" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -160,6 +154,10 @@
+
+
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -193,6 +191,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
+ </li>
+ </ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
</a>
@@ -209,11 +254,9 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Using Custom Checkstyle Property Expansion Definitions</h2>
-<p>Custom <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Properties">property expansion definitions</a>
- for the Checker can be defined.</p>
+<p>Custom <a href="http://checkstyle.sourceforge.net/config.html#Properties" class="externalLink">property expansion definitions</a> for the Checker can be defined.</p>
<p>Checkstyle uses the property expansion mechanism to allow injection of specific values into a pre-defined Checker configuration. Using property expansion alone is an insufficient means to customize the checks performed by Checkstyle.</p>
-<p>Example: <tt>checkstyle.xml</tt>
- - only checks the package name in use to ensure that it conforms to the desired scheme, but allows for users of this Checker to specify their own projectname.</p>
+<p>Example: <tt>checkstyle.xml</tt> - only checks the package name in use to ensure that it conforms to the desired scheme, but allows for users of this Checker to specify their own projectname.</p>
<div class="source"><pre><?xml version="1.0" ?>
<!DOCTYPE module PUBLIC
@@ -230,9 +273,7 @@
</module>
</pre>
</div>
-<p>Example: <tt>pom.xml</tt>
- - Specifies the <b>projectname</b>
- property expansion that Checkstyle will use when encountering such a variable in the above Checker configuration.</p>
+<p>Example: <tt>pom.xml</tt> - Specifies the <tt>projectname</tt> property expansion that Checkstyle will use when encountering such a variable in the above Checker configuration.</p>
<div class="source"><pre><project>
...
<reporting>
@@ -240,6 +281,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<propertyExpansion>projectname=whizbang</propertyExpansion>
@@ -251,9 +293,7 @@
</project>
</pre>
</div>
-<p>The property expansion information can also come from a location using the <tt>propertiesLocation</tt>
- parameter as shown below. The <tt>propertiesLocation</tt>
- can point to a URL, File or build classpath resource reference.</p>
+<p>The property expansion information can also come from a location using the <tt>propertiesLocation</tt> parameter as shown below. The <tt>propertiesLocation</tt> can point to a URL, File or build classpath resource reference.</p>
<div class="source"><pre><project>
...
<reporting>
@@ -261,6 +301,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<propertesLocation>${basedir}/checkstyle.properties</propertiesLocation>
@@ -281,7 +322,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -292,7 +333,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/multi-module-config.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/multi-module-config.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/multi-module-config.html Tue May 8 13:52:31 2012
@@ -20,7 +20,7 @@
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
<meta name="author" content="2008-02-05" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -160,6 +154,10 @@
+
+
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -193,6 +191,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
+ </li>
+ </ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
</a>
@@ -209,9 +254,8 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Multimodule Configuration</h2>
-<p>Configuring the Checkstyle plugin for use within large multimodule projects can be done, but it requires a little setup.</p>
-<p>This example will use a mysterious project called <i>whizbang</i>
-. This is what the structure of that project looks like:</p>
+<p>Configuring the Checkstyle Plugin for use within large multimodule projects can be done, but it requires a little setup.</p>
+<p>This example will use a mysterious project called <i>whizbang</i>. This is what the structure of that project looks like:</p>
<div class="source"><pre>whizbang
|-- pom.xml
|-- core
@@ -224,8 +268,7 @@
</pre>
</div>
<div class="section"><h3>Create a subproject to house the resources</h3>
-<p>We'll start by adding another sub project that will house our common configuration. Let's call it <i>build-tools</i>
-. In it we put the resources that we want to include. In this example, we will add configuration files for the Checkstyle plugin. Configuration files for other plugins, like the PMD plugin, can be included in the same subproject if you like. </p>
+<p>We'll start by adding another sub project that will house our common configuration. Let's call it <i>build-tools</i>. In it we put the resources that we want to include. In this example, we will add configuration files for the Checkstyle Plugin. Configuration files for other plugins, like the PMD plugin, can be included in the same subproject if you like.</p>
<div class="source"><pre>whizbang
|-- pom.xml
|-- build-tools
@@ -242,20 +285,11 @@
`-- src
</pre>
</div>
-<p><b>Tip:</b>
- put the resources into a subdirectory that you can ensure will be unique and not conflict with anyone else.</p>
+<p><b>Tip:</b> put the resources into a subdirectory that you can ensure will be unique and not conflict with anyone else.</p>
</div>
<div class="section"><h3>Configure the other projects to use it</h3>
-<p>Now we can include the Checkstyle configuration in the top level <tt>pom.xml</tt>
-.</p>
-<p><b>Note:</b>
- You have to specify a plugin dependency on <i>build-tools</i>
- in the <tt><build></tt>
- element of your <tt>pom.xml</tt>
-. It will not work inside the <tt><reporting></tt>
- element, because <tt><reporting></tt>
- does not support plugin dependencies. The rest of the configuration is done in the normal way in the <tt><reporting></tt>
- element.</p>
+<p>Now we can include the Checkstyle configuration in the top level <tt>pom.xml</tt>.</p>
+<p><b>Note:</b> You have to specify a plugin dependency on <tt>build-tools</tt> in the <tt><build></tt> element of your <tt>pom.xml</tt>. It will not work inside the <tt><reporting></tt> element, because <tt><reporting></tt> does not support plugin dependencies. The rest of the configuration is done in the normal way in the <tt><reporting></tt> element.</p>
<div class="source"><pre><project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.whizbang</groupId>
@@ -268,6 +302,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.3</version>
<dependencies>
<dependency>
<groupId>com.example.whizbang</groupId>
@@ -283,6 +318,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<configLocation>whizbang/checkstyle.xml</configLocation>
<headerLocation>whizbang/LICENSE.txt</headerLocation>
@@ -299,11 +335,8 @@
</project>
</pre>
</div>
-<p>Once you are done with that, ensure that you do not include maven-checkstyle-plugin in your sub modules, as their definition and configuration, will override the top level parent pom's definition.</p>
-<p>Based on the Checkstyle plugin configuration above, the values of <tt>configLocation</tt>
- and <tt>headerLocation</tt>
- will be resolved from the classpath. The <i>build-tools</i>
- jar was included in the classpath when it was declared as a dependency to the plugin.</p>
+<p>Once you are done with that, ensure that you do not include the Maven Checkstyle Plugin in your sub modules, as their definition and configuration, will override the top level parent pom's definition.</p>
+<p>Based on the Checkstyle Plugin configuration above, the values of <tt>configLocation</tt> and <tt>headerLocation</tt> will be resolved from the classpath. The <i>build-tools</i> JAR was included in the classpath when it was declared as a dependency to the plugin.</p>
<p>Lastly, kick off a build of the site.</p>
<div class="source"><pre>mvn site
</pre>
@@ -319,7 +352,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -330,7 +363,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/suppressions-filter.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/suppressions-filter.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/examples/suppressions-filter.html Tue May 8 13:52:31 2012
@@ -20,7 +20,7 @@
</style>
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
<meta name="author" content="July 2006" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -160,6 +154,10 @@
+
+
+
+
<li class="collapsed">
<a href="../project-info.html">Project Information</a>
@@ -193,6 +191,53 @@
<a href="../project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
+ </li>
+ </ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
</a>
@@ -209,10 +254,8 @@
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Using a Suppressions Filter</h2>
-<p>Checkstyle allows the definition of a list of files and their line ranges that should be suppressed from reporting any violations (known as a <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Filters">suppressions filter</a>
- ).</p>
-<p>Example: <tt>checkstyle-suppressions.xml</tt>
-</p>
+<p>Checkstyle allows the definition of a list of files and their line ranges that should be suppressed from reporting any violations (known as a <a href="http://checkstyle.sourceforge.net/config.html#Filters" class="externalLink">suppressions filter</a> ).</p>
+<p>Example: <tt>checkstyle-suppressions.xml</tt></p>
<div class="source"><pre><?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
@@ -229,8 +272,7 @@
</suppressions>
</pre>
</div>
-<p>Example: <tt>pom.xml</tt>
- - Specifies the suppressions filter that Checkstyle should use.</p>
+<p>Example: <tt>pom.xml</tt> - Specifies the suppressions filter that Checkstyle should use.</p>
<div class="source"><pre><project>
...
<reporting>
@@ -238,6 +280,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
@@ -259,7 +302,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -270,7 +313,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/faq.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/faq.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/faq.html Tue May 8 13:52:31 2012
@@ -19,7 +19,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -52,27 +52,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -80,7 +72,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -159,6 +153,10 @@
+
+
+
+
<li class="collapsed">
<a href="project-info.html">Project Information</a>
@@ -192,6 +190,53 @@
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
+ </li>
+ </ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
</a>
@@ -207,47 +252,37 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2><a name="top">Frequently Asked Questions</a>
-</h2>
-<ol type="1"><li><a href="#How_are_the_Checkstyle_properties_set">How are the Checkstyle properties set?</a>
-</li>
-<li><a href="#How_do_I_set_a_custom_ruleset">How do I set a custom ruleset?</a>
-</li>
-<li><a href="#How_do_I_include_the_test_directory_in_Checkstyle">How do I include the test directory in Checkstyle?</a>
-</li>
+ <div class="section"><h2><a name="top">Frequently Asked Questions</a></h2>
+<ol type="1"><li><a href="#How_are_the_Checkstyle_properties_set">How are the Checkstyle properties set?</a></li>
+<li><a href="#How_do_I_set_a_custom_ruleset">How do I set a custom ruleset?</a></li>
+<li><a href="#How_do_I_include_the_test_directory_in_Checkstyle">How do I include the test directory in Checkstyle?</a></li>
</ol>
</div>
-<dl><dt><a name="How_are_the_Checkstyle_properties_set">How are the Checkstyle properties set?</a>
-</dt>
+<dl><dt><a name="How_are_the_Checkstyle_properties_set">How are the Checkstyle properties set?</a></dt>
<dd>
<p>
- You can set the Checkstyle properties to be used in the plugin configuration of your pom through the
- <strong>propertiesLocation</strong> parameter. The properties file will be resolved by the plugin based
+ You can set the Checkstyle properties to be used in the plugin configuration of your POM through the
+ <code>propertiesLocation</code> parameter. The properties file will be resolved by the plugin based
on its value.
</p>
- <table border="0"><tr><td align="right"><a href="#top">[top]</a>
-</td></tr></table><hr />
+ <table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
</dd>
-<dt><a name="How_do_I_set_a_custom_ruleset">How do I set a custom ruleset?</a>
-</dt>
+<dt><a name="How_do_I_set_a_custom_ruleset">How do I set a custom ruleset?</a></dt>
<dd>
<p>
- You can set a custom ruleset through the <strong>configLocation</strong> plugin parameter. If no value is
+ You can set a custom ruleset through the <code>configLocation</code> plugin parameter. If no value is
specified, the plugin will use a default ruleset, which is the <code>sun_checks.xml</code>, that is bundled with the
plugin.
</p>
- <table border="0"><tr><td align="right"><a href="#top">[top]</a>
-</td></tr></table><hr />
+ <table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table><hr />
</dd>
-<dt><a name="How_do_I_include_the_test_directory_in_Checkstyle">How do I include the test directory in Checkstyle?</a>
-</dt>
+<dt><a name="How_do_I_include_the_test_directory_in_Checkstyle">How do I include the test directory in Checkstyle?</a></dt>
<dd>
<p>
You can include the test directory in the Checkstyle report by setting the
- <strong>includeTestSourceDirectory</strong> plugin parameter to <strong>true</strong>.
+ <code>includeTestSourceDirectory</code> plugin parameter to <code>true</code>.
</p>
- <table border="0"><tr><td align="right"><a href="#top">[top]</a>
-</td></tr></table></dd>
+ <table border="0"><tr><td align="right"><a href="#top">[top]</a></td></tr></table></dd>
</dl>
</div>
@@ -257,7 +292,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -268,7 +303,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/help-mojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/help-mojo.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/help-mojo.html Tue May 8 13:52:31 2012
@@ -12,14 +12,14 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Checkstyle Plugin - maven-checkstyle-plugin - checkstyle:help</title>
+ <title>Maven Checkstyle Plugin - checkstyle:help</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -52,27 +52,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -80,7 +72,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -159,6 +153,10 @@
+
+
+
+
<li class="collapsed">
<a href="project-info.html">Project Information</a>
@@ -192,6 +190,53 @@
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
+ </li>
+ </ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
</a>
@@ -207,42 +252,83 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2><a name="checkstyle:help"></a>
-checkstyle:help</h2>
+ <div class="section"><h2><a name="checkstyle:help"></a>checkstyle:help</h2>
<p><strong>Full name</strong>:</p>
-<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.2:help</p>
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.3:help</p>
<p><strong>Description</strong>:</p>
-<p>Display help information on
-'org.apache.maven.plugins:maven-checkstyle-plugin' plugin. Call
-'mvn checkstyle:help -Ddetail=true' to display all details.</p>
-<p><strong>Attributes</strong>:</p>
-<ul><li>Requires a Maven 2.0 project to be executed.</li>
-</ul>
-<div class="section"><h3><a name="Optional_Parameters"></a>
-Optional Parameters</h3>
+<div>Display help information on maven-checkstyle-plugin.<br />
+
+ Call
+
+<pre>
+ mvn checkstyle:help -Ddetail=true -Dgoal=<goal-name>
+</pre>
+
+to display parameter details.</div><p><strong>Attributes</strong>:</p>
+<ul></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="#detail">detail</a>
-</strong></td>
+<tr class="b"><td><strong><a href="#detail">detail</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
-<td>If true, display all settable properies for each goal. Default value is: <code>false</code>.</td>
+<td>If <code>true</code>, display all settable properties for each
+goal.<br />
+<strong>Default value is</strong>: <code>false</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#goal">goal</a></strong></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td>The name of the goal for which to show help. If unspecified, all
+goals will be displayed.<br />
+</td>
+</tr>
+<tr class="b"><td><strong><a href="#indentSize">indentSize</a></strong></td>
+<td><code>int</code></td>
+<td><code>-</code></td>
+<td>The number of spaces per indentation level, should be positive.<br />
+<strong>Default value is</strong>: <code>2</code>.</td>
+</tr>
+<tr class="a"><td><strong><a href="#lineLength">lineLength</a></strong></td>
+<td><code>int</code></td>
+<td><code>-</code></td>
+<td>The maximum length of a display line, should be positive.<br />
+<strong>Default value is</strong>: <code>80</code>.</td>
</tr>
</table>
</div>
-<div class="section"><h3><a name="Parameter_Details"></a>
-Parameter Details</h3>
-<p><strong><a name="detail">detail</a>
-:</strong></p>
-<p>If true, display all settable properies for each goal.</p>
-<ul><li><strong>Type</strong>: <code>boolean</code></li>
+<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
+<p><strong><a name="detail">detail</a>:</strong></p>
+<div>If <code>true</code>, display all settable properties for each
+goal.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${detail}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
+<hr />
+<p><strong><a name="goal">goal</a>:</strong></p>
+<div>The name of the goal for which to show help. If unspecified, all
+goals will be displayed.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${goal}</code></li>
+</ul>
+<hr />
+<p><strong><a name="indentSize">indentSize</a>:</strong></p>
+<div>The number of spaces per indentation level, should be positive.</div><ul><li><strong>Type</strong>: <code>int</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${indentSize}</code></li>
+<li><strong>Default</strong>: <code>2</code></li>
+</ul>
+<hr />
+<p><strong><a name="lineLength">lineLength</a>:</strong></p>
+<div>The maximum length of a display line, should be positive.</div><ul><li><strong>Type</strong>: <code>int</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>Expression</strong>: <code>${lineLength}</code></li>
+<li><strong>Default</strong>: <code>80</code></li>
+</ul>
</div>
</div>
@@ -253,7 +339,7 @@ Parameter Details</h3>
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -264,7 +350,7 @@ Parameter Details</h3>
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/images/close.gif
==============================================================================
Binary file - no diff available.
Propchange: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/images/close.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/images/collapsed.gif
==============================================================================
Binary files - no diff available.
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/images/expanded.gif
==============================================================================
Binary files - no diff available.
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/index.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/index.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/index.html Tue May 8 13:52:31 2012
@@ -20,7 +20,7 @@
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="Maria Odea Ching" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -53,27 +53,19 @@
<div class="xleft">
- Last Published: 2008-05-31
- | Version: 2.2
- </div>
- <div class="xright"> <a href="http://www.apache.org/" class="externalLink">Apache</a>
- |
- <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
- |
- <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
- |
- <a href="http://maven.apache.org/plugins/" class="externalLink">Maven 2.x Plugins</a>
- |
- <a href="http://maven.apache.org/continuum" class="externalLink">Continuum</a>
- |
- <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
- |
- <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
- |
- <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
- |
- <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
-
+
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven</a>
+ >
+
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ >
+
+ <a href="../../../../../people.apache.org/www/maven.apache.org/plugins/maven-checkstyle-plugin">Maven Checkstyle Plugin</a>
+ </div>
+ <div class="xright">
@@ -81,7 +73,9 @@
- </div>
+ Last Published: 2009-07-10
+ | Version: 2.3
+ </div>
<div class="clear">
<hr/>
</div>
@@ -143,6 +137,10 @@
+
+
+
+
@@ -161,9 +159,55 @@
- <li class="collapsed">
+ <li class="expanded">
<a href="project-info.html">Project Information</a>
- </li>
+ <ul>
+
+ <li class="none">
+ <strong>About</strong>
+ </li>
+
+ <li class="none">
+ <a href="integration.html">Continuous Integration</a>
+ </li>
+
+ <li class="none">
+ <a href="dependencies.html">Dependencies</a>
+ </li>
+
+ <li class="none">
+ <a href="issue-tracking.html">Issue Tracking</a>
+ </li>
+
+ <li class="none">
+ <a href="mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="plugin-management.html">Plugin Management</a>
+ </li>
+
+ <li class="none">
+ <a href="license.html">Project License</a>
+ </li>
+
+ <li class="none">
+ <a href="plugins.html">Project Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="project-summary.html">Project Summary</a>
+ </li>
+
+ <li class="none">
+ <a href="team-list.html">Project Team</a>
+ </li>
+
+ <li class="none">
+ <a href="source-repository.html">Source Repository</a>
+ </li>
+ </ul>
+ </li>
@@ -193,6 +237,53 @@
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
+ <h5>Maven Projects</h5>
+ <ul>
+
+ <li class="none">
+ <a href="http://maven.apache.org/ant-tasks/index.html" class="externalLink">Ant Tasks</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/doxia/index.html" class="externalLink">Doxia</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/jxr/index.html" class="externalLink">JXR</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/maven-1.x/index.html" class="externalLink">Maven 1.x</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/index.html" class="externalLink">Maven 2</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/mercury/index.html" class="externalLink">Mercury</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/plugins/index.html" class="externalLink">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/scm/index.html" class="externalLink">SCM</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/shared/index.html" class="externalLink">Shared Components</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/surefire/index.html" class="externalLink">Surefire</a>
+ </li>
+
+ <li class="none">
+ <a href="http://maven.apache.org/wagon/index.html" class="externalLink">Wagon</a>
+ </li>
+ </ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
</a>
@@ -208,38 +299,27 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Maven 2 Checkstyle Plugin</h2>
-<p>The Checkstyle plugin generates report regarding the code style used by the developers. For more information about Checkstyle, see <a class="externalLink" href="http://checkstyle.sourceforge.net/">http://checkstyle.sourceforge.net/</a>
-</p>
-<p>The plugin can be configured in the project's pom. Predefined rulesets are included with the plugin, these are: <tt>sun_checks.xml</tt>
-, <tt>turbine_checks.xml</tt>
-, <tt>avalon_checks.xml</tt>
- and <tt>maven_checks.xml</tt>
-. You can also use a custom ruleset by specifying it in the plugin configuration.</p>
+ <div class="section"><h2>Maven Checkstyle Plugin</h2>
+<p>The Checkstyle Plugin generates a report regarding the code style used by the developers. For more information about Checkstyle, see <a href="http://checkstyle.sourceforge.net/" class="externalLink">http://checkstyle.sourceforge.net/</a></p>
+<p>The plugin can be configured in the project's POM. Predefined rulesets are included with the plugin, these are: <tt>sun_checks.xml</tt>, <tt>turbine_checks.xml</tt>, <tt>avalon_checks.xml</tt> and <tt>maven_checks.xml</tt>. You can also use a custom ruleset by specifying it in the plugin configuration.</p>
<div class="section"><h3>Goals Overview</h3>
<p>The Checkstyle Plugin has two goals:</p>
-<ul><li><a href="checkstyle-mojo.html">checkstyle:checkstyle</a>
- performs Checkstyle analysis and generates a report on violations.</li>
-<li><a href="check-mojo.html">checkstyle:check</a>
- performs 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.</li>
+<ul><li><a href="checkstyle-mojo.html">checkstyle:checkstyle</a> performs Checkstyle analysis and generates a report on violations.</li>
+<li><a href="check-mojo.html">checkstyle:check</a> performs 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.</li>
</ul>
</div>
<div class="section"><h3>Usage</h3>
-<p>Instructions on how to use the Checkstyle Plugin can be found <a href="usage.html">here</a>
-.</p>
+<p>General instructions on how to use the Checkstyle Plugin can be found on the <a href="usage.html">usage page</a>. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the <a href="http://docs.codehaus.org/display/MAVENUSER/Checkstyle+Plugin" class="externalLink">plugin's wiki page</a>.</p>
+<p>In case you still have questions regarding the plugin's usage, please have a look at the <a href="faq.html">FAQ</a> and feel free to contact the <a href="mail-lists.html">user mailing list</a>. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the <a href="mail-lists.html">mail archive</a>.</p>
+<p>If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our <a href="issue-tracking.html">issue tracker</a>. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our <a href="source-repository.html">source repository</a> and will find supplementary information in the <a href="http://maven.apache.org/guides/development/guide-helping.html" class="externalLink">guide to helping with Maven</a>.</p>
</div>
<div class="section"><h3>Examples</h3>
<p>The following examples show how to use the Checkstyle Plugin in more advanced usecases:</p>
-<ul><li><a href="examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
-</li>
-<li><a href="examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a>
-</li>
-<li><a href="examples/suppressions-filter.html">Using a Suppressions Filter</a>
-</li>
-<li><a href="examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Check Modules</a>
-</li>
-<li><a href="examples/multi-module-config.html">Multimodule Configuration</a>
-</li>
+<ul><li><a href="examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a></li>
+<li><a href="examples/custom-property-expansion.html">Using Custom Checkstyle Property Expansion Definitions</a></li>
+<li><a href="examples/suppressions-filter.html">Using a Suppressions Filter</a></li>
+<li><a href="examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Check Modules</a></li>
+<li><a href="examples/multi-module-config.html">Multimodule Configuration</a></li>
</ul>
</div>
</div>
@@ -251,7 +331,7 @@
</div>
<div id="footer">
<div class="xright">©
- 2005-2008
+ 2005-2009
The Apache Software Foundation
@@ -262,7 +342,7 @@
- </div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
<div class="clear">
<hr/>
</div>