You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2014/03/11 21:12:55 UTC
svn commit: r901148 [12/48] - in
/websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST:
./ apidocs/ apidocs/org/apache/maven/plugin/pmd/
apidocs/org/apache/maven/plugin/pmd/class-use/
apidocs/org/apache/maven/plugin/pmd/model/ api...
Modified: websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/checkstyle.rss
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/checkstyle.rss (original)
+++ websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/checkstyle.rss Tue Mar 11 20:12:51 2014
@@ -2,15 +2,15 @@
<rss version="0.91">
<channel>
- <title>Maven PMD Plugin - Checkstyle report</title>
+ <title>Apache Maven PMD Plugin - Checkstyle report</title>
<link>http://maven.apache.org/plugins/maven-pmd-plugin/</link>
- <description>Maven PMD Plugin - Checkstyle report</description>
+ <description>Apache Maven PMD Plugin - Checkstyle report</description>
<language>en-us</language>
- <copyright>©2005 - 2013 The Apache Software Foundation</copyright>
+ <copyright>©2005 - 2014 The Apache Software Foundation</copyright>
<item>
- <title>File: 10,
- Errors: 10,
- Warnings: 30,
+ <title>File: 12,
+ Errors: 4,
+ Warnings: 40,
Infos: 0
</title>
<link>http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html</link>
@@ -29,16 +29,16 @@
<tbody>
<tr>
<td>
- <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.PmdReport.java">org/apache/maven/plugin/pmd/PmdReport.java</a>
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.PmdReportGenerator.java">org/apache/maven/plugin/pmd/PmdReportGenerator.java</a>
</td>
<td>
0
</td>
<td>
- 1
+ 8
</td>
<td>
- 2
+ 0
</td>
</tr>
<tr>
@@ -52,21 +52,21 @@
0
</td>
<td>
- 1
+ 0
</td>
</tr>
<tr>
<td>
- <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo.java">org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java</a>
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.PmdReportListener.java">org/apache/maven/plugin/pmd/PmdReportListener.java</a>
</td>
<td>
0
</td>
<td>
- 13
+ 3
</td>
<td>
- 6
+ 0
</td>
</tr>
<tr>
@@ -85,27 +85,27 @@
</tr>
<tr>
<td>
- <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.AbstractPmdReport.java">org/apache/maven/plugin/pmd/AbstractPmdReport.java</a>
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo.java">org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java</a>
</td>
<td>
0
</td>
<td>
- 4
+ 13
</td>
<td>
- 0
+ 2
</td>
</tr>
<tr>
<td>
- <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.ViolationDetails.java">org/apache/maven/plugin/pmd/ViolationDetails.java</a>
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.rules.DummyRule.java">org/apache/maven/plugin/pmd/rules/DummyRule.java</a>
</td>
<td>
0
</td>
<td>
- 0
+ 1
</td>
<td>
0
@@ -127,27 +127,41 @@
</tr>
<tr>
<td>
- <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.CpdReport.java">org/apache/maven/plugin/pmd/CpdReport.java</a>
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.CpdReportGenerator.java">org/apache/maven/plugin/pmd/CpdReportGenerator.java</a>
</td>
<td>
0
</td>
<td>
+ 2
+ </td>
+ <td>
0
</td>
+ </tr>
+ <tr>
<td>
- 1
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.AbstractPmdReport.java">org/apache/maven/plugin/pmd/AbstractPmdReport.java</a>
+ </td>
+ <td>
+ 0
+ </td>
+ <td>
+ 5
+ </td>
+ <td>
+ 0
</td>
</tr>
<tr>
<td>
- <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.PmdReportListener.java">org/apache/maven/plugin/pmd/PmdReportListener.java</a>
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.ViolationDetails.java">org/apache/maven/plugin/pmd/ViolationDetails.java</a>
</td>
<td>
0
</td>
<td>
- 6
+ 0
</td>
<td>
0
@@ -155,7 +169,7 @@
</tr>
<tr>
<td>
- <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.CpdReportGenerator.java">org/apache/maven/plugin/pmd/CpdReportGenerator.java</a>
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.CpdReport.java">org/apache/maven/plugin/pmd/CpdReport.java</a>
</td>
<td>
0
@@ -167,6 +181,20 @@
0
</td>
</tr>
+ <tr>
+ <td>
+ <a href="http://maven.apache.org/plugins/maven-pmd-plugin//checkstyle.html#org.apache.maven.plugin.pmd.PmdReport.java">org/apache/maven/plugin/pmd/PmdReport.java</a>
+ </td>
+ <td>
+ 0
+ </td>
+ <td>
+ 2
+ </td>
+ <td>
+ 2
+ </td>
+ </tr>
</tbody>
</table>
Modified: websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/cpd-check-mojo.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/cpd-check-mojo.html (original)
+++ websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/cpd-check-mojo.html Tue Mar 11 20:12:51 2014
@@ -1,11 +1,11 @@
<!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 Mar 4, 2013
+ | Generated by Apache Maven Doxia at 2014-03-11
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven PMD plugin -
+ <title>Apache Maven PMD Plugin -
pmd:cpd-check</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@@ -13,10 +13,10 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20130304" />
+ <meta name="Date-Revision-yyyymmdd" content="20140311" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
<script type="text/javascript">_uacct = "UA-140879-1";
urchinTracker();</script>
@@ -42,14 +42,14 @@
>
<a href="../index.html">Plugins</a>
>
- <a href="./">Maven PMD plugin</a>
+ <a href="./">Apache Maven PMD Plugin</a>
>
pmd:cpd-check
</div>
<div class="xright">
- Last Published: 2013-03-04
- | Version: 3.0.1
+ Last Published: 2014-03-11
+ | Version: 3.1
</div>
<div class="clear">
<hr/>
@@ -99,7 +99,7 @@
<li class="collapsed">
<a href="project-info.html">Project Information</a>
</li>
- <li class="collapsed">
+ <li class="collapsed">
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
@@ -173,148 +173,267 @@
<div id="contentBox">
- <div class="section"><h2>pmd:cpd-check<a name="pmd:cpd-check"></a></h2>
- <p><b>Full name</b>:</p>
- <p>org.apache.maven.plugins:maven-pmd-plugin:3.0.1:cpd-check</p>
- <p><b>Description</b>:</p>
- <div>Fail the build if there were any CPD violations in the source code.</div>
- <p><b>Attributes</b>:</p>
- <ul>
- <li>Requires a Maven project to be executed.</li>
- <li>The goal is thread-safe and supports parallel builds.</li>
- <li>Since version: <tt>2.0</tt>.</li>
- <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>verify</tt>.</li>
- <li>Invokes the execution of this plugin's goal <tt>cpd</tt> prior to executing itself.</li>
+ <div class="section">
+<h2>pmd:cpd-check<a name="pmd:cpd-check"></a></h2>
+
+<p><b>Full name</b>:</p>
+
+<p>org.apache.maven.plugins:maven-pmd-plugin:3.1:cpd-check</p>
+
+<p><b>Description</b>:</p>
+
+<div>Fail the build if there were any CPD violations in the source code.</div>
+
+<p><b>Attributes</b>:</p>
+
+<ul>
+
+<li>Requires a Maven project to be executed.</li>
+
+<li>The goal is thread-safe and supports parallel builds.</li>
+
+<li>Since version: <tt>2.0</tt>.</li>
+
+<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>verify</tt>.</li>
+
+<li>Invokes the execution of this plugin's goal <tt>cpd</tt> prior to executing itself.</li>
</ul>
- <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
- <table class="bodyTable" border="0">
- <tr class="a">
- <th>Name</th>
- <th>Type</th>
- <th>Since</th>
- <th>Description</th>
+
+<div class="section">
+<h3>Required Parameters<a name="Required_Parameters"></a></h3>
+
+<table class="bodyTable" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
</tr>
- <tr class="b">
- <td><b><a href="#failOnViolation">failOnViolation</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>3.0</tt></td>
- <td>Whether to fail the build if the validation check fails.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>cpd.failOnViolation</tt>.</td>
+
+<tr class="b">
+
+<td><b><a href="#failOnViolation">failOnViolation</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>3.0</tt></td>
+
+<td>Whether to fail the build if the validation check fails.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>cpd.failOnViolation</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#targetDirectory">targetDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>2.0</tt></td>
- <td>The location of the XML report to check, as generated by the PMD
+
+<tr class="a">
+
+<td><b><a href="#targetDirectory">targetDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>The location of the XML report to check, as generated by the PMD
report.<br /><b>User property is</b>: <tt>project.build.directory</tt>.</td>
</tr>
</table>
</div>
- <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
- <table class="bodyTable" border="0">
- <tr class="a">
- <th>Name</th>
- <th>Type</th>
- <th>Since</th>
- <th>Description</th>
+
+<div class="section">
+<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+
+<table class="bodyTable" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
</tr>
- <tr class="b">
- <td><b><a href="#aggregate">aggregate</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.2</tt></td>
- <td>Whether to build an aggregated report at the root, or build
+
+<tr class="b">
+
+<td><b><a href="#aggregate">aggregate</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>Whether to build an aggregated report at the root, or build
individual reports.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>aggregate</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#excludeFromFailureFile">excludeFromFailureFile</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>3.0</tt></td>
- <td>File that lists classes and rules to be excluded from failures For
+
+<tr class="a">
+
+<td><b><a href="#excludeFromFailureFile">excludeFromFailureFile</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>3.0</tt></td>
+
+<td>File that lists classes and rules to be excluded from failures For
PMD, this is a properties file For CPD, this is a text file that
contains comma-separated lists of classes that are allowed to
duplicate<br /><b>User property is</b>: <tt>pmd.excludeFromFailureFile</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#printFailingErrors">printFailingErrors</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>3.0</tt></td>
- <td>Print details of errors that cause build failure<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>pmd.printFailingErrors</tt>.</td>
+
+<tr class="b">
+
+<td><b><a href="#printFailingErrors">printFailingErrors</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>3.0</tt></td>
+
+<td>Print details of errors that cause build failure<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>pmd.printFailingErrors</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#skip">skip</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.0</tt></td>
- <td>Skip the CPD violation checks. Most useful on the command line via
+
+<tr class="a">
+
+<td><b><a href="#skip">skip</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>Skip the CPD violation checks. Most useful on the command line via
"-Dcpd.skip=true".<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cpd.skip</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#verbose">verbose</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.0</tt></td>
- <td>Print details of check failures to build output.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>pmd.verbose</tt>.</td>
+
+<tr class="b">
+
+<td><b><a href="#verbose">verbose</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>Print details of check failures to build output.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>pmd.verbose</tt>.</td>
</tr>
</table>
</div>
- <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
- <p><b><a name="aggregate">aggregate</a>:</b></p>
- <div>Whether to build an aggregated report at the root, or build
+
+<div class="section">
+<h3>Parameter Details<a name="Parameter_Details"></a></h3>
+
+<p><b><a name="aggregate">aggregate</a>:</b></p>
+
+<div>Whether to build an aggregated report at the root, or build
individual reports.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>aggregate</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="excludeFromFailureFile">excludeFromFailureFile</a>:</b></p>
- <div>File that lists classes and rules to be excluded from failures For
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>aggregate</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="excludeFromFailureFile">excludeFromFailureFile</a>:</b></p>
+
+<div>File that lists classes and rules to be excluded from failures For
PMD, this is a properties file For CPD, this is a text file that
contains comma-separated lists of classes that are allowed to
duplicate</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>3.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>pmd.excludeFromFailureFile</tt></li>
- </ul><hr /><p><b><a name="failOnViolation">failOnViolation</a>:</b></p>
- <div>Whether to fail the build if the validation check fails.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>3.0</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>User Property</b>: <tt>cpd.failOnViolation</tt></li>
- <li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /><p><b><a name="printFailingErrors">printFailingErrors</a>:</b></p>
- <div>Print details of errors that cause build failure</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>3.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>pmd.printFailingErrors</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="skip">skip</a>:</b></p>
- <div>Skip the CPD violation checks. Most useful on the command line via
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>3.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>pmd.excludeFromFailureFile</tt></li>
+ </ul><hr />
+<p><b><a name="failOnViolation">failOnViolation</a>:</b></p>
+
+<div>Whether to fail the build if the validation check fails.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>3.0</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>cpd.failOnViolation</tt></li>
+
+<li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr />
+<p><b><a name="printFailingErrors">printFailingErrors</a>:</b></p>
+
+<div>Print details of errors that cause build failure</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>3.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>pmd.printFailingErrors</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="skip">skip</a>:</b></p>
+
+<div>Skip the CPD violation checks. Most useful on the command line via
"-Dcpd.skip=true".</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>cpd.skip</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="targetDirectory">targetDirectory</a>:</b></p>
- <div>The location of the XML report to check, as generated by the PMD
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>cpd.skip</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="targetDirectory">targetDirectory</a>:</b></p>
+
+<div>The location of the XML report to check, as generated by the PMD
report.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>User Property</b>: <tt>project.build.directory</tt></li>
- </ul><hr /><p><b><a name="verbose">verbose</a>:</b></p>
- <div>Print details of check failures to build output.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>pmd.verbose</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>project.build.directory</tt></li>
+ </ul><hr />
+<p><b><a name="verbose">verbose</a>:</b></p>
+
+<div>Print details of check failures to build output.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>pmd.verbose</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
</ul>
</div>
</div>
@@ -327,7 +446,7 @@ report.</div>
</div>
<div id="footer">
<div class="xright">
- © 2005-2013
+ © 2005-2014
The Apache Software Foundation
- <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
Modified: websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/cpd-mojo.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/cpd-mojo.html (original)
+++ websites/production/maven/content/plugins-archives/maven-pmd-plugin-LATEST/cpd-mojo.html Tue Mar 11 20:12:51 2014
@@ -1,11 +1,11 @@
<!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 Mar 4, 2013
+ | Generated by Apache Maven Doxia at 2014-03-11
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven PMD plugin -
+ <title>Apache Maven PMD Plugin -
pmd:cpd</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@@ -13,10 +13,10 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20130304" />
+ <meta name="Date-Revision-yyyymmdd" content="20140311" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
<script type="text/javascript">_uacct = "UA-140879-1";
urchinTracker();</script>
@@ -42,14 +42,14 @@
>
<a href="../index.html">Plugins</a>
>
- <a href="./">Maven PMD plugin</a>
+ <a href="./">Apache Maven PMD Plugin</a>
>
pmd:cpd
</div>
<div class="xright">
- Last Published: 2013-03-04
- | Version: 3.0.1
+ Last Published: 2014-03-11
+ | Version: 3.1
</div>
<div class="clear">
<hr/>
@@ -99,7 +99,7 @@
<li class="collapsed">
<a href="project-info.html">Project Information</a>
</li>
- <li class="collapsed">
+ <li class="collapsed">
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
@@ -173,71 +173,123 @@
<div id="contentBox">
- <div class="section"><h2>pmd:cpd<a name="pmd:cpd"></a></h2>
- <p><b>Note</b>:This goal should be used as a Maven report.</p>
- <p><b>Full name</b>:</p>
- <p>org.apache.maven.plugins:maven-pmd-plugin:3.0.1:cpd</p>
- <p><b>Description</b>:</p>
- <div>Creates a report for PMD's CPD tool. See <a class="externalLink" href="http://pmd.sourceforge.net/cpd.html">http://pmd.sourceforge.net/cpd.html</a>
+ <div class="section">
+<h2>pmd:cpd<a name="pmd:cpd"></a></h2>
+
+<p><b>Note</b>:This goal should be used as a Maven report.</p>
+
+<p><b>Full name</b>:</p>
+
+<p>org.apache.maven.plugins:maven-pmd-plugin:3.1:cpd</p>
+
+<p><b>Description</b>:</p>
+
+<div>Creates a report for PMD's CPD tool. See <a class="externalLink" href="http://pmd.sourceforge.net/cpd.html">http://pmd.sourceforge.net/cpd.html</a>
for more detail.</div>
- <p><b>Attributes</b>:</p>
- <ul>
- <li>Requires a Maven project to be executed.</li>
- <li>The goal is thread-safe and supports parallel builds.</li>
- <li>Since version: <tt>2.0</tt>.</li>
+
+<p><b>Attributes</b>:</p>
+
+<ul>
+
+<li>Requires a Maven project to be executed.</li>
+
+<li>The goal is thread-safe and supports parallel builds.</li>
+
+<li>Since version: <tt>2.0</tt>.</li>
</ul>
- <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
- <table class="bodyTable" border="0">
- <tr class="a">
- <th>Name</th>
- <th>Type</th>
- <th>Since</th>
- <th>Description</th>
- </tr>
- <tr class="b">
- <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>2.0</tt></td>
- <td>The output directory for the final HTML report. Note that this
+
+<div class="section">
+<h3>Required Parameters<a name="Required_Parameters"></a></h3>
+
+<table class="bodyTable" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#outputDirectory">outputDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>The output directory for the final HTML report. Note that this
parameter is only evaluated if the goal is run directly from the
command line or during the default lifecycle. If the goal is run
indirectly as part of a site generation, the output directory
configured in the Maven Site Plugin is used instead.<br /><b>User property is</b>: <tt>project.reporting.outputDirectory</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#targetDirectory">targetDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>2.0</tt></td>
- <td>The output directory for the intermediate XML report.<br /><b>User property is</b>: <tt>project.build.directory</tt>.</td>
+
+<tr class="a">
+
+<td><b><a href="#targetDirectory">targetDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>The output directory for the intermediate XML report.<br /><b>User property is</b>: <tt>project.build.directory</tt>.</td>
</tr>
</table>
</div>
- <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
- <table class="bodyTable" border="0">
- <tr class="a">
- <th>Name</th>
- <th>Type</th>
- <th>Since</th>
- <th>Description</th>
- </tr>
- <tr class="b">
- <td><b><a href="#aggregate">aggregate</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.2</tt></td>
- <td>Whether to build an aggregated report at the root, or build
+
+<div class="section">
+<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+
+<table class="bodyTable" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#aggregate">aggregate</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>Whether to build an aggregated report at the root, or build
individual reports.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>aggregate</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#excludeRoots">excludeRoots</a></b></td>
- <td><tt>File[]</tt></td>
- <td><tt>2.2</tt></td>
- <td>The project source directories that should be excluded.<br /></td>
- </tr>
- <tr class="b">
- <td><b><a href="#excludes">excludes</a></b></td>
- <td><tt>List</tt></td>
- <td><tt>2.2</tt></td>
- <td>A list of files to exclude from checking. Can contain Ant-style
+
+<tr class="a">
+
+<td><b><a href="#excludeRoots">excludeRoots</a></b></td>
+
+<td><tt>File[]</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>The project source directories that should be excluded.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#excludes">excludes</a></b></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>A list of files to exclude from checking. Can contain Ant-style
wildcards and double wildcards. Note that these exclusion patterns
only operate on the path of a source file relative to its source
root directory. In other words, files are excluded based on their
@@ -245,262 +297,488 @@ package and/or class name. If you want t
root directories, use the parameter <tt>excludeRoots</tt>
instead.<br /></td>
</tr>
- <tr class="a">
- <td><b><a href="#format">format</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.0</tt></td>
- <td>Set the output format type, in addition to the HTML report. Must be
+
+<tr class="a">
+
+<td><b><a href="#format">format</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>Set the output format type, in addition to the HTML report. Must be
one of: "none", "csv", "xml", "txt" or the full class name of the
PMD renderer to use. See the net.sourceforge.pmd.renderers package
javadoc for available renderers. XML is required if the pmd:check
goal is being used.<br /><b>Default value is</b>: <tt>xml</tt>.<br /><b>User property is</b>: <tt>format</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#ignoreIdentifiers">ignoreIdentifiers</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.5</tt></td>
- <td>Similar to <tt>ignoreLiterals</tt> but for identifiers; i.e.,
+
+<tr class="b">
+
+<td><b><a href="#ignoreIdentifiers">ignoreIdentifiers</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.5</tt></td>
+
+<td>Similar to <tt>ignoreLiterals</tt> but for identifiers; i.e.,
variable names, methods names, and so forth.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cpd.ignoreIdentifiers</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#ignoreLiterals">ignoreLiterals</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.5</tt></td>
- <td>If true, CPD ignores literal value differences when evaluating a
+
+<tr class="a">
+
+<td><b><a href="#ignoreLiterals">ignoreLiterals</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.5</tt></td>
+
+<td>If true, CPD ignores literal value differences when evaluating a
duplicate block. This means that <tt>foo=42;</tt> and
<tt>foo=43;</tt> will be seen as equivalent. You may want to
run PMD with this option off to start with and then switch it on to
see what it turns up.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cpd.ignoreLiterals</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#includeTests">includeTests</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.2</tt></td>
- <td>Run PMD on the tests.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#includeXmlInSite">includeXmlInSite</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>3.0</tt></td>
- <td>Whether to include the xml files generated by PMD/CPD in the
+
+<tr class="b">
+
+<td><b><a href="#includeTests">includeTests</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>Run PMD on the tests.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#includeXmlInSite">includeXmlInSite</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>3.0</tt></td>
+
+<td>Whether to include the xml files generated by PMD/CPD in the
site.<br />
<b>Note:</b> In versions 2.2 - 2.7.1 the default value
for this was <tt>true</tt>. This was changed in version 3.0.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
</tr>
- <tr class="b">
- <td><b><a href="#includes">includes</a></b></td>
- <td><tt>List</tt></td>
- <td><tt>2.2</tt></td>
- <td>A list of files to include from checking. Can contain Ant-style
+
+<tr class="b">
+
+<td><b><a href="#includes">includes</a></b></td>
+
+<td><tt>List</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>A list of files to include from checking. Can contain Ant-style
wildcards and double wildcards. Defaults to **\/*.java.<br /></td>
</tr>
- <tr class="a">
- <td><b><a href="#linkXRef">linkXRef</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.0</tt></td>
- <td>Link the violation line numbers to the source xref. Links will be
+
+<tr class="a">
+
+<td><b><a href="#linkXRef">linkXRef</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>Link the violation line numbers to the source xref. Links will be
created automatically if the jxr plugin is being used.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>linkXRef</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#minimumTokens">minimumTokens</a></b></td>
- <td><tt>int</tt></td>
- <td><tt>2.0</tt></td>
- <td>The minimum number of tokens that need to be duplicated before it
+
+<tr class="b">
+
+<td><b><a href="#minimumTokens">minimumTokens</a></b></td>
+
+<td><tt>int</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>The minimum number of tokens that need to be duplicated before it
causes a violation.<br /><b>Default value is</b>: <tt>100</tt>.<br /><b>User property is</b>: <tt>minimumTokens</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#outputEncoding">outputEncoding</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.5</tt></td>
- <td>The file encoding when writing non-HTML reports.<br /><b>Default value is</b>: <tt>${project.reporting.outputEncoding}</tt>.<br /><b>User property is</b>: <tt>outputEncoding</tt>.</td>
- </tr>
- <tr class="b">
- <td><b><a href="#skip">skip</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.1</tt></td>
- <td>Skip the CPD report generation. Most useful on the command line via
+
+<tr class="a">
+
+<td><b><a href="#outputEncoding">outputEncoding</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.5</tt></td>
+
+<td>The file encoding when writing non-HTML reports.<br /><b>Default value is</b>: <tt>${project.reporting.outputEncoding}</tt>.<br /><b>User property is</b>: <tt>outputEncoding</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#skip">skip</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.1</tt></td>
+
+<td>Skip the CPD report generation. Most useful on the command line via
"-Dcpd.skip=true".<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>cpd.skip</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#sourceEncoding">sourceEncoding</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.3</tt></td>
- <td>The file encoding to use when reading the Java sources.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.<br /><b>User property is</b>: <tt>encoding</tt>.</td>
- </tr>
- <tr class="b">
- <td><b><a href="#xrefLocation">xrefLocation</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>2.0</tt></td>
- <td>Location of the Xrefs to link to.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}/xref</tt>.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#xrefTestLocation">xrefTestLocation</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>2.0</tt></td>
- <td>Location of the Test Xrefs to link to.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}/xref-test</tt>.<br /></td>
+
+<tr class="a">
+
+<td><b><a href="#skipEmptyReport">skipEmptyReport</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>3.1</tt></td>
+
+<td>Skip the PMD/CPD report generation if there are no violations or
+duplications found. Defaults to <tt>true</tt>.<br /><b>Default value is</b>: <tt>true</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#sourceEncoding">sourceEncoding</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.3</tt></td>
+
+<td>The file encoding to use when reading the Java sources.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.<br /><b>User property is</b>: <tt>encoding</tt>.</td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#xrefLocation">xrefLocation</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>Location of the Xrefs to link to.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}/xref</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#xrefTestLocation">xrefTestLocation</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>2.0</tt></td>
+
+<td>Location of the Test Xrefs to link to.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}/xref-test</tt>.<br /></td>
</tr>
</table>
</div>
- <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
- <p><b><a name="aggregate">aggregate</a>:</b></p>
- <div>Whether to build an aggregated report at the root, or build
+
+<div class="section">
+<h3>Parameter Details<a name="Parameter_Details"></a></h3>
+
+<p><b><a name="aggregate">aggregate</a>:</b></p>
+
+<div>Whether to build an aggregated report at the root, or build
individual reports.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>aggregate</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="excludeRoots">excludeRoots</a>:</b></p>
- <div>The project source directories that should be excluded.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File[]</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="excludes">excludes</a>:</b></p>
- <div>A list of files to exclude from checking. Can contain Ant-style
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>aggregate</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="excludeRoots">excludeRoots</a>:</b></p>
+
+<div>The project source directories that should be excluded.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File[]</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr />
+<p><b><a name="excludes">excludes</a>:</b></p>
+
+<div>A list of files to exclude from checking. Can contain Ant-style
wildcards and double wildcards. Note that these exclusion patterns
only operate on the path of a source file relative to its source
root directory. In other words, files are excluded based on their
package and/or class name. If you want to exclude entire source
root directories, use the parameter <tt>excludeRoots</tt>
instead.</div>
- <ul>
- <li><b>Type</b>: <tt>java.util.List</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="format">format</a>:</b></p>
- <div>Set the output format type, in addition to the HTML report. Must be
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr />
+<p><b><a name="format">format</a>:</b></p>
+
+<div>Set the output format type, in addition to the HTML report. Must be
one of: "none", "csv", "xml", "txt" or the full class name of the
PMD renderer to use. See the net.sourceforge.pmd.renderers package
javadoc for available renderers. XML is required if the pmd:check
goal is being used.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>format</tt></li>
- <li><b>Default</b>: <tt>xml</tt></li>
- </ul><hr /><p><b><a name="ignoreIdentifiers">ignoreIdentifiers</a>:</b></p>
- <div>Similar to <tt>ignoreLiterals</tt> but for identifiers; i.e.,
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>format</tt></li>
+
+<li><b>Default</b>: <tt>xml</tt></li>
+ </ul><hr />
+<p><b><a name="ignoreIdentifiers">ignoreIdentifiers</a>:</b></p>
+
+<div>Similar to <tt>ignoreLiterals</tt> but for identifiers; i.e.,
variable names, methods names, and so forth.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.5</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>cpd.ignoreIdentifiers</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="ignoreLiterals">ignoreLiterals</a>:</b></p>
- <div>If true, CPD ignores literal value differences when evaluating a
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.5</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>cpd.ignoreIdentifiers</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="ignoreLiterals">ignoreLiterals</a>:</b></p>
+
+<div>If true, CPD ignores literal value differences when evaluating a
duplicate block. This means that <tt>foo=42;</tt> and
<tt>foo=43;</tt> will be seen as equivalent. You may want to
run PMD with this option off to start with and then switch it on to
see what it turns up.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.5</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>cpd.ignoreLiterals</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="includeTests">includeTests</a>:</b></p>
- <div>Run PMD on the tests.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="includeXmlInSite">includeXmlInSite</a>:</b></p>
- <div>Whether to include the xml files generated by PMD/CPD in the
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.5</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>cpd.ignoreLiterals</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="includeTests">includeTests</a>:</b></p>
+
+<div>Run PMD on the tests.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="includeXmlInSite">includeXmlInSite</a>:</b></p>
+
+<div>Whether to include the xml files generated by PMD/CPD in the
site.<br />
<b>Note:</b> In versions 2.2 - 2.7.1 the default value
for this was <tt>true</tt>. This was changed in version 3.0.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>3.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="includes">includes</a>:</b></p>
- <div>A list of files to include from checking. Can contain Ant-style
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>3.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="includes">includes</a>:</b></p>
+
+<div>A list of files to include from checking. Can contain Ant-style
wildcards and double wildcards. Defaults to **\/*.java.</div>
- <ul>
- <li><b>Type</b>: <tt>java.util.List</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="linkXRef">linkXRef</a>:</b></p>
- <div>Link the violation line numbers to the source xref. Links will be
+
+<ul>
+
+<li><b>Type</b>: <tt>java.util.List</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr />
+<p><b><a name="linkXRef">linkXRef</a>:</b></p>
+
+<div>Link the violation line numbers to the source xref. Links will be
created automatically if the jxr plugin is being used.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>linkXRef</tt></li>
- <li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /><p><b><a name="minimumTokens">minimumTokens</a>:</b></p>
- <div>The minimum number of tokens that need to be duplicated before it
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>linkXRef</tt></li>
+
+<li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr />
+<p><b><a name="minimumTokens">minimumTokens</a>:</b></p>
+
+<div>The minimum number of tokens that need to be duplicated before it
causes a violation.</div>
- <ul>
- <li><b>Type</b>: <tt>int</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>minimumTokens</tt></li>
- <li><b>Default</b>: <tt>100</tt></li>
- </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
- <div>The output directory for the final HTML report. Note that this
+
+<ul>
+
+<li><b>Type</b>: <tt>int</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>minimumTokens</tt></li>
+
+<li><b>Default</b>: <tt>100</tt></li>
+ </ul><hr />
+<p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
+
+<div>The output directory for the final HTML report. Note that this
parameter is only evaluated if the goal is run directly from the
command line or during the default lifecycle. If the goal is run
indirectly as part of a site generation, the output directory
configured in the Maven Site Plugin is used instead.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>User Property</b>: <tt>project.reporting.outputDirectory</tt></li>
- </ul><hr /><p><b><a name="outputEncoding">outputEncoding</a>:</b></p>
- <div>The file encoding when writing non-HTML reports.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.5</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>outputEncoding</tt></li>
- <li><b>Default</b>: <tt>${project.reporting.outputEncoding}</tt></li>
- </ul><hr /><p><b><a name="skip">skip</a>:</b></p>
- <div>Skip the CPD report generation. Most useful on the command line via
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>project.reporting.outputDirectory</tt></li>
+ </ul><hr />
+<p><b><a name="outputEncoding">outputEncoding</a>:</b></p>
+
+<div>The file encoding when writing non-HTML reports.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.5</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>outputEncoding</tt></li>
+
+<li><b>Default</b>: <tt>${project.reporting.outputEncoding}</tt></li>
+ </ul><hr />
+<p><b><a name="skip">skip</a>:</b></p>
+
+<div>Skip the CPD report generation. Most useful on the command line via
"-Dcpd.skip=true".</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.1</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>cpd.skip</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="sourceEncoding">sourceEncoding</a>:</b></p>
- <div>The file encoding to use when reading the Java sources.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.3</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>encoding</tt></li>
- <li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
- </ul><hr /><p><b><a name="targetDirectory">targetDirectory</a>:</b></p>
- <div>The output directory for the intermediate XML report.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>User Property</b>: <tt>project.build.directory</tt></li>
- </ul><hr /><p><b><a name="xrefLocation">xrefLocation</a>:</b></p>
- <div>Location of the Xrefs to link to.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${project.reporting.outputDirectory}/xref</tt></li>
- </ul><hr /><p><b><a name="xrefTestLocation">xrefTestLocation</a>:</b></p>
- <div>Location of the Test Xrefs to link to.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Since</b>: <tt>2.0</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${project.reporting.outputDirectory}/xref-test</tt></li>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.1</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>cpd.skip</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="skipEmptyReport">skipEmptyReport</a>:</b></p>
+
+<div>Skip the PMD/CPD report generation if there are no violations or
+duplications found. Defaults to <tt>true</tt>.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>3.1</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr />
+<p><b><a name="sourceEncoding">sourceEncoding</a>:</b></p>
+
+<div>The file encoding to use when reading the Java sources.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.3</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>encoding</tt></li>
+
+<li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
+ </ul><hr />
+<p><b><a name="targetDirectory">targetDirectory</a>:</b></p>
+
+<div>The output directory for the intermediate XML report.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>project.build.directory</tt></li>
+ </ul><hr />
+<p><b><a name="xrefLocation">xrefLocation</a>:</b></p>
+
+<div>Location of the Xrefs to link to.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.reporting.outputDirectory}/xref</tt></li>
+ </ul><hr />
+<p><b><a name="xrefTestLocation">xrefTestLocation</a>:</b></p>
+
+<div>Location of the Test Xrefs to link to.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>2.0</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.reporting.outputDirectory}/xref-test</tt></li>
</ul>
</div>
</div>
@@ -513,7 +791,7 @@ configured in the Maven Site Plugin is u
</div>
<div id="footer">
<div class="xright">
- © 2005-2013
+ © 2005-2014
The Apache Software Foundation
- <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.