<?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>PMD Plug-in 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>
      </table>
    </section>
  </body>
</document>
