You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 16:00:20 UTC
svn commit: r816663 [10/31] - in
/websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest:
./ apidocs/ apidocs/org/apache/maven/plugin/checkstyle/
apidocs/org/apache/maven/plugin/checkstyle/class-use/
apidocs/org/apache/maven/plugi...
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 14:00:13 2012
@@ -1,15 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
+<!-- Generated by Apache Maven Doxia at Aug 8, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Maven Checkstyle Plugin - Using a Custom Checkstyle Checker Configuration</title>
@@ -19,62 +9,43 @@
@import url("../css/site.css");
</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=UTF-8" />
+ <meta name="author" content="July 2006" />
+ <meta name="Date-Revision-yyyymmdd" content="20110808" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></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>
- <span id="bannerRight">
-
- <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
-
- </span>
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="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">
-
-
-
-
-
-
-
- Last Published: 2010-09-22
- | Version: 2.6
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" class="externalLink">Maven Checkstyle Plugin</a>
+ >
+ Maven Checkstyle Plugin - Using a Custom Checkstyle Checker Configuration
+ </div>
+ <div class="xright">
+ Last Published: 2011-08-08
+ | Version: 2.7
</div>
<div class="clear">
<hr/>
@@ -82,176 +53,90 @@
</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>
+
+ <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">
- <strong>Using a Custom Checkstyle Checker Configuration</strong>
- </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>
+ <h5>Examples</h5>
+ <ul>
+ <li class="none">
+ <strong>Using a Custom Checkstyle Checker Configuration</strong>
+ </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>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
</ul>
- <h5>Maven Projects</h5>
- <ul>
-
- <li class="none">
- <a href="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>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
-
-
-
-
-
-
-
- </div>
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
@@ -262,7 +147,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
</configuration>
@@ -270,27 +155,20 @@
</plugins>
</reporting>
...
-</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></ul></div>
+</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></ul></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2005-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2005-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
<div class="clear">
<hr/>
</div>
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 14:00:13 2012
@@ -1,15 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
+<!-- Generated by Apache Maven Doxia at Aug 8, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Maven Checkstyle Plugin - Using Custom Developed Checkstyle Checks</title>
@@ -19,62 +9,43 @@
@import url("../css/site.css");
</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=UTF-8" />
+ <meta name="author" content="2008-02-04" />
+ <meta name="Date-Revision-yyyymmdd" content="20110808" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></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>
- <span id="bannerRight">
-
- <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
-
- </span>
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="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">
-
-
-
-
-
-
-
- Last Published: 2010-09-22
- | Version: 2.6
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" class="externalLink">Maven Checkstyle Plugin</a>
+ >
+ Maven Checkstyle Plugin - Using Custom Developed Checkstyle Checks
+ </div>
+ <div class="xright">
+ Last Published: 2011-08-08
+ | Version: 2.7
</div>
<div class="clear">
<hr/>
@@ -82,176 +53,90 @@
</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>
+
+ <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">
- <strong>Using Custom Developed Checkstyle Checks</strong>
- </li>
-
- <li class="none">
- <a href="../examples/multi-module-config.html">Multimodule Configuration</a>
- </li>
+ <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">
+ <strong>Using Custom Developed Checkstyle Checks</strong>
+ </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>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
</ul>
- <h5>Maven Projects</h5>
- <ul>
-
- <li class="none">
- <a href="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>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
-
-
-
-
-
-
-
- </div>
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
@@ -264,8 +149,7 @@
`-- mycompany
`-- checks
|-- packagenames.xml
- `-- MethodLimitCheck.java
-</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><a name="pom.xml"></a></h4><p>Not much to say here, except that we add a dependency on Checkstyle.</p><div class="source"><pre><project>
+ `-- MethodLimitCheck.java</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><a name="pom.xml"></a></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>
<groupId>com.mycompany</groupId>
<artifactId>mycompany-checkstyle-checks</artifactId>
@@ -275,11 +159,10 @@
<dependency>
<groupId>checkstyle</groupId>
<artifactId>checkstyle</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
</dependency>
</dependencies>
-</project>
-</pre></div></div><div class="section"><h4><tt>packagenames.xml</tt><a name="packagenames.xml"></a></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"?>
+</project></pre></div></div><div class="section"><h4><tt>packagenames.xml</tt><a name="packagenames.xml"></a></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
"-//Puppy Crawl//DTD Package Names 1.0//EN"
@@ -306,8 +189,7 @@
</package>
<package name="filters"/>
</package>
-</checkstyle-packages>
-</pre></div></div><div class="section"><h4><tt>MethodLimitCheck.java</tt><a name="MethodLimitCheck.java"></a></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;
+</checkstyle-packages></pre></div></div><div class="section"><h4><tt>MethodLimitCheck.java</tt><a name="MethodLimitCheck.java"></a></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.*;
public class MethodLimitCheck extends Check
@@ -332,9 +214,7 @@ public class MethodLimitCheck extends Ch
"too many methods, only " + max + " are allowed");
}
}
-}
-</pre></div></div></div><div class="section"><h3>Building a JAR for your custom checks project<a name="Building_a_JAR_for_your_custom_checks_project"></a></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><a name="mycompany-checkstyle-checks-1.0.jar"></a></h4><div class="source"><pre>mycompany-checkstyle-checks-1.0.jar
+}</pre></div></div></div><div class="section"><h3>Building a JAR for your custom checks project<a name="Building_a_JAR_for_your_custom_checks_project"></a></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><a name="mycompany-checkstyle-checks-1.0.jar"></a></h4><div class="source"><pre>mycompany-checkstyle-checks-1.0.jar
|-- pom.xml
|-- META-INF
| |-- MANIFEST.MF
@@ -347,8 +227,7 @@ public class MethodLimitCheck extends Ch
`-- mycompany
`-- checks
|-- packagenames.xml
- `-- MethodLimitCheck.class
-</pre></div></div></div><div class="section"><h3>Using your checks in another project<a name="Using_your_checks_in_another_project"></a></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<a name="Create_a_Checkstyle_configuration"></a></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><div class="source"><pre><?xml version="1.0" ?>
+ `-- MethodLimitCheck.class</pre></div></div></div><div class="section"><h3>Using your checks in another project<a name="Using_your_checks_in_another_project"></a></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<a name="Create_a_Checkstyle_configuration"></a></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><div class="source"><pre><?xml version="1.0" ?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
@@ -358,15 +237,14 @@ public class MethodLimitCheck extends Ch
<module name="TreeWalker">
<module name="MethodLimit"/>
</module>
-</module>
-</pre></div></div><div class="section"><h4>Configure the Checkstyle Plugin to use your custom checks<a name="Configure_the_Checkstyle_Plugin_to_use_your_custom_checks"></a></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>
+</module></pre></div></div><div class="section"><h4>Configure the Checkstyle Plugin to use your custom checks<a name="Configure_the_Checkstyle_Plugin_to_use_your_custom_checks"></a></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>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
<dependencies>
<dependency>
<groupId>com.mycompany</groupId>
@@ -382,7 +260,7 @@ public class MethodLimitCheck extends Ch
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<packageNamesLocation>com/mycompany/checks/packagenames.xml</packageNamesLocation>
@@ -391,27 +269,20 @@ public class MethodLimitCheck extends Ch
</plugins>
</reporting>
...
-</project>
-</pre></div></div></div></div>
+</project></pre></div></div></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2005-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2005-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
<div class="clear">
<hr/>
</div>
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 14:00:13 2012
@@ -1,15 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
+<!-- Generated by Apache Maven Doxia at Aug 8, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Maven Checkstyle Plugin - Using Custom Checkstyle Property Expansion Definitions</title>
@@ -19,62 +9,43 @@
@import url("../css/site.css");
</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=UTF-8" />
+ <meta name="author" content="July 2006" />
+ <meta name="Date-Revision-yyyymmdd" content="20110808" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></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>
- <span id="bannerRight">
-
- <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
-
- </span>
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="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">
-
-
-
-
-
-
-
- Last Published: 2010-09-22
- | Version: 2.6
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" class="externalLink">Maven Checkstyle Plugin</a>
+ >
+ Maven Checkstyle Plugin - Using Custom Checkstyle Property Expansion Definitions
+ </div>
+ <div class="xright">
+ Last Published: 2011-08-08
+ | Version: 2.7
</div>
<div class="clear">
<hr/>
@@ -82,176 +53,90 @@
</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>
+
+ <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">
- <strong>Using Custom Checkstyle Property Expansion Definitions</strong>
- </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>
+ <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">
+ <strong>Using Custom Checkstyle Property Expansion Definitions</strong>
+ </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>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
</ul>
- <h5>Maven Projects</h5>
- <ul>
-
- <li class="none">
- <a href="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>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
-
-
-
-
-
-
-
- </div>
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
@@ -268,15 +153,14 @@
value="com\.example\.$\{projectname\}(\.[a-z][a-zA-Z0-9]+)*$"/>
</module>
</module>
-</module>
-</pre></div><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>
+</module></pre></div><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>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<propertyExpansion>projectname=whizbang</propertyExpansion>
@@ -285,15 +169,14 @@
</plugins>
</reporting>
...
-</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><div class="source"><pre><project>
+</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><div class="source"><pre><project>
...
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<propertesLocation>${basedir}/checkstyle.properties</propertiesLocation>
@@ -302,27 +185,20 @@
</plugins>
</reporting>
...
-</project>
-</pre></div></div>
+</project></pre></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2005-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2005-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
<div class="clear">
<hr/>
</div>
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 14:00:13 2012
@@ -1,15 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
+<!-- Generated by Apache Maven Doxia at Aug 8, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Maven Checkstyle Plugin - Multimodule Configuration</title>
@@ -19,62 +9,43 @@
@import url("../css/site.css");
</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=UTF-8" />
+ <meta name="author" content="2008-02-05" />
+ <meta name="Date-Revision-yyyymmdd" content="20110808" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></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>
- <span id="bannerRight">
-
- <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
-
- </span>
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="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">
-
-
-
-
-
-
-
- Last Published: 2010-09-22
- | Version: 2.6
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" class="externalLink">Maven Checkstyle Plugin</a>
+ >
+ Maven Checkstyle Plugin - Multimodule Configuration
+ </div>
+ <div class="xright">
+ Last Published: 2011-08-08
+ | Version: 2.7
</div>
<div class="clear">
<hr/>
@@ -82,176 +53,90 @@
</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>
+
+ <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>
+ <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">
+ <strong>Multimodule Configuration</strong>
</li>
-
- <li class="none">
- <a href="../examples/custom-developed-checkstyle.html">Using Custom Developed Checkstyle Checks</a>
- </li>
-
- <li class="none">
- <strong>Multimodule Configuration</strong>
- </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>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
</ul>
- <h5>Maven Projects</h5>
- <ul>
-
- <li class="none">
- <a href="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>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
-
-
-
-
-
-
-
- </div>
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
@@ -263,8 +148,7 @@
| `-- pom.xml
|-- jmx
| `-- pom.xml
-`-- src
-</pre></div><div class="section"><h3>Create a subproject to house the resources<a name="Create_a_subproject_to_house_the_resources"></a></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><div class="source"><pre>whizbang
+`-- src</pre></div><div class="section"><h3>Create a subproject to house the resources<a name="Create_a_subproject_to_house_the_resources"></a></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><div class="source"><pre>whizbang
|-- pom.xml
|-- build-tools
| |-- src
@@ -277,8 +161,7 @@
|-- core
|-- gui
|-- jmx
-`-- 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></div><div class="section"><h3>Configure the other projects to use it<a name="Configure_the_other_projects_to_use_it"></a></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 <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>
+`-- 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></div><div class="section"><h3>Configure the other projects to use it<a name="Configure_the_other_projects_to_use_it"></a></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 <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>
<artifactId>whizbang-parent</artifactId>
@@ -290,7 +173,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
<dependencies>
<dependency>
<groupId>com.example.whizbang</groupId>
@@ -306,7 +189,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
<configuration>
<configLocation>whizbang/checkstyle.xml</configLocation>
<headerLocation>whizbang/LICENSE.txt</headerLocation>
@@ -320,28 +203,20 @@
<module>jmx</module>
<module>gui</module>
</modules>
-</project>
-</pre></div><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></div><p>Every sub project will now use the same Checkstyle setup and configuration.</p></div></div>
+</project></pre></div><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></div><p>Every sub project will now use the same Checkstyle setup and configuration.</p></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2005-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2005-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
<div class="clear">
<hr/>
</div>
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 14:00:13 2012
@@ -1,15 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-
-
-
-
-
-
-
-
-
+<!-- Generated by Apache Maven Doxia at Aug 8, 2011 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Maven Checkstyle Plugin - Using a Suppressions Filter</title>
@@ -19,62 +9,43 @@
@import url("../css/site.css");
</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=UTF-8" />
+ <meta name="author" content="July 2006" />
+ <meta name="Date-Revision-yyyymmdd" content="20110808" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></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>
- <span id="bannerRight">
-
- <img src="http://maven.apache.org/images/maven-logo-2.gif" alt="" />
-
- </span>
+ <a href="../../../" id="bannerLeft">
+ <img src="../../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../../images/maven-logo-2.gif" alt="" />
+ </span>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
-
-
-
-
-
-
-
- <div class="xleft">
-
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
-
- <a href="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">
-
-
-
-
-
-
-
- Last Published: 2010-09-22
- | Version: 2.6
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../../index.html">Maven</a>
+ >
+ <a href="../../index.html">Plugins</a>
+ >
+ <a href="http://maven.apache.org/plugins/maven-checkstyle-plugin/" class="externalLink">Maven Checkstyle Plugin</a>
+ >
+ Maven Checkstyle Plugin - Using a Suppressions Filter
+ </div>
+ <div class="xright">
+ Last Published: 2011-08-08
+ | Version: 2.7
</div>
<div class="clear">
<hr/>
@@ -82,176 +53,90 @@
</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>
+
+ <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">
- <strong>Using a Suppressions Filter</strong>
- </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>
+ <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">
+ <strong>Using a Suppressions Filter</strong>
+ </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>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html">Project Reports</a>
+ </li>
</ul>
- <h5>Maven Projects</h5>
- <ul>
-
- <li class="none">
- <a href="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>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../../index.html">Maven 2</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../../wagon/index.html">Wagon</a>
+ </li>
</ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
- </a>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
+ </a>
-
-
-
-
-
-
-
- </div>
+ </div>
</div>
<div id="bodyColumn">
<div id="contentBox">
@@ -268,15 +153,14 @@
<suppress checks="MagicNumberCheck"
files="LegacyDatasetConvertor.java"
lines="221,250-295"/>
-</suppressions>
-</pre></div><p>Example: <tt>pom.xml</tt> - Specifies the suppressions filter that Checkstyle should use.</p><div class="source"><pre><project>
+</suppressions></pre></div><p>Example: <tt>pom.xml</tt> - Specifies the suppressions filter that Checkstyle should use.</p><div class="source"><pre><project>
...
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
@@ -286,27 +170,20 @@
</plugins>
</reporting>
...
-</project>
-</pre></div></div>
+</project></pre></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
- <div class="xright">©
- 2005-2010
-
- The Apache Software Foundation
-
-
-
-
-
+ <div class="xright">
+ © 2005-2011
+ The Apache Software Foundation
-
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a></div>
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
<div class="clear">
<hr/>
</div>