maven-plugins/pmd/xdocs/properties.xml
aheritier 059391c473 Update docs
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@388980 13f79535-47bb-0310-9956-ffa450edef68
2006-03-26 23:04:17 +00:00

129 lines
3.9 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Properties</title>
<author email="siegfried.goeschl@it20one.at">Siegfried Goeschl</author>
</properties>
<body>
<section name="PMD Plug-in Properties">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.pmd.enable</td>
<td>No</td>
<td>
Enable/disable the PMD plugin. Has to be set to "true"
to enable the plugin
</td>
</tr>
<tr>
<td>maven.pmd.rulesetfiles</td>
<td>Yes</td>
<td>
Defines the rule to be used for running PMD. Is
already defined in the plugin
</td>
</tr>
<tr>
<td>maven.pmd.includes</td>
<td>Yes</td>
<td>
Specifies a comma-separated list of Ant patterns to use
when matching files in the source tree to be included in the
PMD report. The pattern specified is relative to
<code>${maven.src.dir}</code>. The default value is
<code>**/*.java</code>, which matches all Java source files
in the source tree (specified by the <code>${maven.src.dir}</code>
property.
</td>
</tr>
<tr>
<td>maven.pmd.excludes</td>
<td>Yes</td>
<td>
Specifies a comma-separated list of Ant patterns to use when
matching files in the source tree to be excluded from the
PMD report. The pattern specified is relative to
<code>${maven.src.dir}</code>. The default value is to not
exclude any files.
</td>
</tr>
<tr>
<td>maven.pmd.cpd.enable</td>
<td>Yes</td>
<td>
Enable/disable the CPD report. Defaults to "false".
</td>
</tr>
<tr>
<td>maven.pmd.cpd.minimumtokencount</td>
<td>Yes</td>
<td>
Specifies the minimal number required to consider two sequences of
tokens identical. Defaults to "100".
</td>
</tr>
<tr>
<td>maven.pmd.check.tests</td>
<td>Yes</td>
<td>
Whether or not to run PMD on test sources. Defaults to true.
</td>
</tr>
<tr>
<td>maven.pmd.console</td>
<td>Yes</td>
<td>
Whether or not to display PMD errors to the console. Defaults to false.
</td>
</tr>
<tr>
<td>maven.pmd.failonerror</td>
<td>Yes</td>
<td>
Whether or not to fail the build if any errors occur while processing the files. Defaults to false.
</td>
</tr>
<tr>
<td>maven.pmd.failonruleviolation</td>
<td>Yes</td>
<td>
Whether or not to fail the build if PMD finds any problems. Defaults to false.
</td>
</tr>
<tr>
<td>maven.pmd.targetjdk</td>
<td>Yes</td>
<td>
Target JDK 1.3, 1.4, or 1.5.. Defaults to ${maven.compile.source}.
</td>
</tr>
</table>
</section>
</body>
</document>