Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/aggregate-pmd-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/aggregate-pmd-mojo.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/aggregate-pmd-mojo.html Fri May 12 20:25:56 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target\generated-site\xdoc/aggregate-pmd-mojo.xml at 2023-01-06 + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target\generated-site\xdoc/aggregate-pmd-mojo.xml at 2023-05-12 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> @@ -49,8 +49,8 @@ <li class=""><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> <li class=""><a href="index.html" title="Apache Maven PMD Plugin">Apache Maven PMD Plugin</a><span class="divider">/</span></li> <li class="active ">pmd:aggregate-pmd</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-01-06</li> - <li id="projectVersion" class="pull-right">Version: 3.20.0</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-05-12</li> + <li id="projectVersion" class="pull-right">Version: 3.21.0</li> </ul> </div> </header> @@ -126,14 +126,11 @@ <p><b>Full name</b>:</p> -<p>org.apache.maven.plugins:maven-pmd-plugin:3.20.0:aggregate-pmd</p> +<p>org.apache.maven.plugins:maven-pmd-plugin:3.21.0:aggregate-pmd</p> <p><b>Description</b>:</p> -<div>Creates a PMD site report in an <b>aggregator</b> project based on -the rulesets and configuration set in the plugin. It can also -generate a pmd output file aside from the site report in any of the -following formats: xml, csv or txt.</div> +<div>Creates a PMD site report in an <b>aggregator</b> project based on the rulesets and configuration set in the plugin. It can also generate a pmd output file aside from the site report in any of the following formats: xml, csv or txt.</div> <p><b>Attributes</b>:</p> @@ -173,7 +170,7 @@ following formats: xml, csv or txt.</div <td><code>File</code></td> -<td><code>3.15.0</code></td> +<td><code>-</code></td> <td>The output directory for the intermediate XML report.<br /><b>User property is</b>: <code>project.build.directory</code>.<br /></td> </tr> @@ -203,8 +200,7 @@ following formats: xml, csv or txt.</div <td><code>2.2</code></td> -<td><b>Deprecated.</b> since 3.15.0 Use the goals <code>pmd:aggregate-pmd</code> and -<code>pmd:aggregate-cpd</code> instead.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>aggregate</code>.<br /></td> +<td><b>Deprecated.</b> Whether to build an aggregated report at the root, or build individual reports.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>aggregate</code>.<br /></td> </tr> <tr class="a"> @@ -215,9 +211,7 @@ following formats: xml, csv or txt.</div <td><code>3.8</code></td> -<td>Enables the analysis cache, which speeds up PMD. This requires a -cache file, that contains the results of the last PMD run. Thus the -cache is only effective, if this file is not cleaned between runs.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>pmd.analysisCache</code>.<br /></td> +<td>Enables the analysis cache, which speeds up PMD. This requires a cache file, that contains the results of the last PMD run. Thus the cache is only effective, if this file is not cleaned between runs.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>pmd.analysisCache</code>.<br /></td> </tr> <tr class="b"> @@ -228,12 +222,7 @@ cache is only effective, if this file is <td><code>3.8</code></td> -<td>The location of the analysis cache, if it is enabled. This file -contains the results of the last PMD run and must not be cleaned -between consecutive PMD runs. Otherwise the cache is not in use. If -the file doesn't exist, PMD executes as if there is no cache -enabled and all files are analyzed. Otherwise only changed files -will be analyzed again.<br /><b>Default value is</b>: <code>${project.build.directory}/pmd/pmd.cache</code>.<br /><b>User property is</b>: <code>pmd.analysisCacheLocation</code>.<br /></td> +<td>The location of the analysis cache, if it is enabled. This file contains the results of the last PMD run and must not be cleaned between consecutive PMD runs. Otherwise the cache is not in use. If the file doesn't exist, PMD executes as if there is no cache enabled and all files are analyzed. Otherwise only changed files will be analyzed again.<br /><b>Default value is</b>: <code>${project.build.directory}/pmd/pmd.cache</code>.<br /><b>User property is</b>: <code>pmd.analysisCacheLocation</code>.<br /></td> </tr> <tr class="a"> @@ -262,12 +251,11 @@ will be analyzed again.<br /><b>Default <td align="left"><code><a href="#compileSourceRoots"><compileSourceRoots></a></code></td> -<td><code>List</code></td> +<td><code>List<String></code></td> <td><code>3.7</code></td> -<td>Specifies the location of the source directories to be used for -PMD. Defaults to <code>project.compileSourceRoots</code>.<br /><b>Default value is</b>: <code>${project.compileSourceRoots}</code>.<br /></td> +<td>Specifies the location of the source directories to be used for PMD. Defaults to <code>project.compileSourceRoots</code>.<br /><b>Default value is</b>: <code>${project.compileSourceRoots}</code>.<br /></td> </tr> <tr class="b"> @@ -278,10 +266,7 @@ PMD. Defaults to <code>project.compileSo <td><code>3.7</code></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>: <code>pmd.excludeFromFailureFile</code>.<br /></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>: <code>pmd.excludeFromFailureFile</code>.<br /></td> </tr> <tr class="a"> @@ -299,17 +284,11 @@ duplicate.<br /><b>User property is</b>: <td align="left"><code><a href="#excludes"><excludes></a></code></td> -<td><code>List</code></td> +<td><code>List<String></code></td> <td><code>2.2</code></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 -package and/or class name. If you want to exclude entire source -root directories, use the parameter <code>excludeRoots</code> -instead.<br /></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 package and/or class name. If you want to exclude entire source root directories, use the parameter <code>excludeRoots</code> instead.<br /></td> </tr> <tr class="a"> @@ -318,72 +297,61 @@ instead.<br /></td> <td><code>String</code></td> -<td><code>3.15.0</code></td> +<td><code>-</code></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 produced in any case, since -this format is needed for the check goals (pmd:check, -pmd:aggregator-check, pmd:cpd-check, pmd:aggregator-cpd-check).<br /><b>Default value is</b>: <code>xml</code>.<br /><b>User property is</b>: <code>format</code>.<br /></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 produced in any case, since this format is needed for the check goals (pmd:check, pmd:aggregator-check, pmd:cpd-check, pmd:aggregator-cpd-check).<br /><b>Default value is</b>: <code>xml</code>.<br /><b>User property is</b>: <code>format</code>.<br /></td> </tr> <tr class="b"> -<td align="left"><code><a href="#includeTests"><includeTests></a></code></td> +<td align="left"><code><a href="#includes"><includes></a></code></td> -<td><code>boolean</code></td> +<td><code>List<String></code></td> <td><code>2.2</code></td> -<td>Run PMD on the tests.<br /><b>Default value is</b>: <code>false</code>.<br /></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 align="left"><code><a href="#includeXmlInSite"><includeXmlInSite></a></code></td> +<td align="left"><code><a href="#includeTests"><includeTests></a></code></td> <td><code>boolean</code></td> -<td><code>3.0</code></td> +<td><code>2.2</code></td> -<td>Whether to include the xml files generated by PMD/CPD in the site.<br /><b>Default value is</b>: <code>false</code>.<br /></td> +<td>Run PMD on the tests.<br /><b>Default value is</b>: <code>false</code>.<br /></td> </tr> <tr class="b"> -<td align="left"><code><a href="#includes"><includes></a></code></td> +<td align="left"><code><a href="#includeXmlInSite"><includeXmlInSite></a></code></td> -<td><code>List</code></td> +<td><code>boolean</code></td> -<td><code>2.2</code></td> +<td><code>3.0</code></td> -<td>A list of files to include from checking. Can contain Ant-style -wildcards and double wildcards. Defaults to **\/*.java.<br /></td> +<td>Whether to include the xml files generated by PMD/CPD in the site.<br /><b>Default value is</b>: <code>false</code>.<br /></td> </tr> <tr class="a"> <td align="left"><code><a href="#jdkToolchain"><jdkToolchain></a></code></td> -<td><code>Map</code></td> +<td><code>Map<String,String></code></td> <td><code>3.14.0</code></td> <td> -<p>Allow for configuration of the jvm used to run PMD via maven -toolchains. This permits a configuration where the project is built -with one jvm and PMD is executed with another. This overrules the -toolchain selected by the maven-toolchain-plugin.</p> +<p>Allow for configuration of the jvm used to run PMD via maven toolchains. This permits a configuration where the project is built with one jvm and PMD is executed with another. This overrules the toolchain selected by the maven-toolchain-plugin.</p> -<p>Examples:</p> -(see <a class="externalLink" href="https://maven.apache.org/guides/mini/guide-using-toolchains.html";>Guide -to Toolchains</a> for more info) +<p>Examples:</p> (see <a class="externalLink" href="https://maven.apache.org/guides/mini/guide-using-toolchains.html";> Guide to Toolchains</a> for more info) <div> <pre> <code> -<configuration> + <configuration> ... <jdkToolchain> <version>1.11</version> @@ -397,10 +365,8 @@ to Toolchains</a> for more info) <vendor>zulu</vendor> </jdkToolchain> </configuration> - </code> -</pre></div> - -<b>note:</b> requires at least Maven 3.3.1<br /></td> + </code> +</pre></div> <b>note:</b> requires at least Maven 3.3.1<br /></td> </tr> <tr class="b"> @@ -411,9 +377,7 @@ to Toolchains</a> for more info) <td><code>3.0</code></td> -<td>The programming language to be analyzed by PMD. Valid values are -currently <code>java</code>, <code>javascript</code> and -<code>jsp</code>.<br /><b>Default value is</b>: <code>java</code>.<br /></td> +<td>The programming language to be analyzed by PMD. Valid values are currently <code>java</code>, <code>javascript</code> and <code>jsp</code>.<br /><b>Default value is</b>: <code>java</code>.<br /></td> </tr> <tr class="a"> @@ -422,10 +386,9 @@ currently <code>java</code>, <code>javas <td><code>boolean</code></td> -<td><code>3.15.0</code></td> +<td><code>-</code></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>: <code>true</code>.<br /><b>User property is</b>: <code>linkXRef</code>.<br /></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>: <code>true</code>.<br /><b>User property is</b>: <code>linkXRef</code>.<br /></td> </tr> <tr class="b"> @@ -436,8 +399,7 @@ created automatically if the jxr plugin <td><code>2.1</code></td> -<td>The rule priority threshold; rules with lower priority than this -will not be evaluated.<br /><b>Default value is</b>: <code>5</code>.<br /><b>User property is</b>: <code>minimumPriority</code>.<br /></td> +<td>The rule priority threshold; rules with lower priority than this will not be evaluated.<br /><b>Default value is</b>: <code>5</code>.<br /><b>User property is</b>: <code>minimumPriority</code>.<br /></td> </tr> <tr class="a"> @@ -448,11 +410,7 @@ will not be evaluated.<br /><b>Default v <td><code>3.9.0</code></td> -<td>Also render processing errors into the HTML report. Processing -errors are problems, that PMD encountered while executing the -rules. It can be parsing errors or exceptions during rule -execution. Processing errors indicate a bug in PMD and the -information provided help in reporting and fixing bugs in PMD.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.renderProcessingErrors</code>.<br /></td> +<td>Also render processing errors into the HTML report. Processing errors are problems, that PMD encountered while executing the rules. It can be parsing errors or exceptions during rule execution. Processing errors indicate a bug in PMD and the information provided help in reporting and fixing bugs in PMD.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.renderProcessingErrors</code>.<br /></td> </tr> <tr class="b"> @@ -474,8 +432,7 @@ information provided help in reporting a <td><code>3.17.0</code></td> -<td>Add a section in the HTML report that lists the suppressed -violations.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.renderSuppressedViolations</code>.<br /></td> +<td>Add a section in the HTML report that lists the suppressed violations.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.renderSuppressedViolations</code>.<br /></td> </tr> <tr class="b"> @@ -486,8 +443,7 @@ violations.<br /><b>Default value is</b> <td><code>3.12.0</code></td> -<td>Add a section in the HTML report, that groups the found violations -by rule priority in addition to grouping by file.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.renderViolationsByPriority</code>.<br /></td> +<td>Add a section in the HTML report, that groups the found violations by rule priority in addition to grouping by file.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.renderViolationsByPriority</code>.<br /></td> </tr> <tr class="a"> @@ -496,12 +452,9 @@ by rule priority in addition to grouping <td><code>String[]</code></td> -<td><code>3.15.0</code></td> +<td><code>-</code></td> -<td>The PMD rulesets to use. See the <a class="externalLink" href="https://pmd.github.io/latest/pmd_rules_java.html";>Stock Java -Rulesets</a> for a list of available rules. Defaults to a custom -ruleset provided by this maven plugin -(<code>/rulesets/java/maven-pmd-plugin-default.xml</code>).<br /></td> +<td>The PMD rulesets to use. See the <a class="externalLink" href="https://pmd.github.io/latest/pmd_rules_java.html";>Stock Java Rulesets</a> for a list of available rules. Defaults to a custom ruleset provided by this maven plugin (<code>/rulesets/java/maven-pmd-plugin-default.xml</code>).<br /></td> </tr> <tr class="b"> @@ -512,11 +465,9 @@ ruleset provided by this maven plugin <td><code>3.13.0</code></td> -<td>Before PMD is executed, the configured rulesets are resolved and -copied into this directory. +<td>Before PMD is executed, the configured rulesets are resolved and copied into this directory. -<p>Note: Before 3.13.0, this was by default -${project.build.directory}.</p><br /><b>Default value is</b>: <code>${project.build.directory}/pmd/rulesets</code>.<br /><b>User property is</b>: <code>pmd.rulesetsTargetDirectory</code>.<br /></td> +<p>Note: Before 3.13.0, this was by default ${project.build.directory}.</p><br /><b>Default value is</b>: <code>${project.build.directory}/pmd/rulesets</code>.<br /><b>User property is</b>: <code>pmd.rulesetsTargetDirectory</code>.<br /></td> </tr> <tr class="a"> @@ -527,11 +478,7 @@ ${project.build.directory}.</p><br /><b> <td><code>3.9.0</code></td> -<td>Redirect PMD log into maven log out. When enabled, the PMD log -output is redirected to maven, so that it is visible in the console -together with all the other log output. Also, if maven is started -with the debug flag (<code>-X</code> or <code>--debug</code>), the -PMD logger is also configured for debug.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.showPmdLog</code>.<br /></td> +<td>Redirect PMD log into maven log out. When enabled, the PMD log output is redirected to maven, so that it is visible in the console together with all the other log output. Also, if maven is started with the debug flag (<code>-X</code> or <code>--debug</code>), the PMD logger is also configured for debug.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.showPmdLog</code>.<br /></td> </tr> <tr class="b"> @@ -542,8 +489,7 @@ PMD logger is also configured for debug. <td><code>2.1</code></td> -<td>Skip the PMD report generation. Most useful on the command line via -"-Dpmd.skip=true".<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>pmd.skip</code>.<br /></td> +<td>Skip the PMD report generation. Most useful on the command line via "-Dpmd.skip=true".<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>pmd.skip</code>.<br /></td> </tr> <tr class="a"> @@ -554,11 +500,9 @@ PMD logger is also configured for debug. <td><code>3.1</code></td> -<td>Skip the PMD/CPD report generation if there are no violations or -duplications found. Defaults to <code>false</code>. +<td>Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults to <code>false</code>. -<p>Note: the default value was changed from <code>true</code> to -<code>false</code> with version 3.13.0.</p><br /><b>Default value is</b>: <code>false</code>.<br /></td> +<p>Note: the default value was changed from <code>true</code> to <code>false</code> with version 3.13.0.</p><br /><b>Default value is</b>: <code>false</code>.<br /></td> </tr> <tr class="b"> @@ -580,10 +524,7 @@ duplications found. Defaults to <code>fa <td><code>3.4</code></td> -<td>Source level marker used to indicate whether a RuleViolation should -be suppressed. If it is not set, PMD's default will be used, which -is <code>NOPMD</code>. See also <a class="externalLink" href="https://pmd.github.io/latest/pmd_userdocs_suppressing_warnings.html";>PMD -- Suppressing warnings</a>.<br /><b>User property is</b>: <code>pmd.suppressMarker</code>.<br /></td> +<td>Source level marker used to indicate whether a RuleViolation should be suppressed. If it is not set, PMD's default will be used, which is <code>NOPMD</code>. See also <a class="externalLink" href="https://pmd.github.io/latest/pmd_userdocs_suppressing_warnings.html";>PMD – Suppressing warnings</a>.<br /><b>User property is</b>: <code>pmd.suppressMarker</code>.<br /></td> </tr> <tr class="b"> @@ -592,34 +533,24 @@ is <code>NOPMD</code>. See also <a class <td><code>String</code></td> -<td><code>3.15.0</code></td> +<td><code>-</code></td> -<td>The target JDK to analyze based on. Should match the source used in -the compiler plugin. Valid values with the default PMD version are -currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code>, -<code>1.6</code>, <code>1.7</code>, <code>1.8</code>, -<code>9</code>, <code>10</code>, <code>11</code>, <code>12</code>, -<code>13</code>, <code>14</code>, <code>15</code>, <code>16</code>, -<code>17</code>, <code>18</code>, and <code>19</code>. +<td>The target JDK to analyze based on. Should match the source used in the compiler plugin. Valid values with the default PMD version are currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code>, <code>1.6</code>, <code>1.7</code>, <code>1.8</code>, <code>9</code>, <code>10</code>, <code>11</code>, <code>12</code>, <code>13</code>, <code>14</code>, <code>15</code>, <code>16</code>, <code>17</code>, <code>18</code>, <code>19</code>, and <code>20</code>. -<p>You can override the default PMD version by specifying PMD as a -dependency, see <a href="examples/upgrading-PMD-at-runtime.html">Upgrading PMD at -Runtime</a>.</p> +<p>You can override the default PMD version by specifying PMD as a dependency, see <a href="examples/upgrading-PMD-at-runtime.html">Upgrading PMD at Runtime</a>.</p> -<p><b>Note:</b> this parameter is only used if the language -parameter is set to <code>java</code>.</p><br /><b>Default value is</b>: <code>${maven.compiler.source}</code>.<br /><b>User property is</b>: <code>targetJdk</code>.<br /></td> +<p><b>Note:</b> this parameter is only used if the language parameter is set to <code>java</code>.</p><br /><b>Default value is</b>: <code>${maven.compiler.source}</code>.<br /><b>User property is</b>: <code>targetJdk</code>.<br /></td> </tr> <tr class="a"> <td align="left"><code><a href="#testSourceRoots"><testSourceRoots></a></code></td> -<td><code>List</code></td> +<td><code>List<String></code></td> <td><code>3.7</code></td> -<td>The directories containing the test-sources to be used for PMD. -Defaults to <code>project.testCompileSourceRoots</code><br /><b>Default value is</b>: <code>${project.testCompileSourceRoots}</code>.<br /></td> +<td>The directories containing the test-sources to be used for PMD. Defaults to <code>project.testCompileSourceRoots</code><br /><b>Default value is</b>: <code>${project.testCompileSourceRoots}</code>.<br /></td> </tr> <tr class="b"> @@ -630,8 +561,7 @@ Defaults to <code>project.testCompileSou <td><code>3.0</code></td> -<td>Controls whether the project's compile/test classpath should be -passed to PMD to enable its type resolution feature.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.typeResolution</code>.<br /></td> +<td>Controls whether the project's compile/test classpath should be passed to PMD to enable its type resolution feature.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>pmd.typeResolution</code>.<br /></td> </tr> <tr class="a"> @@ -640,7 +570,7 @@ passed to PMD to enable its type resolut <td><code>File</code></td> -<td><code>3.15.0</code></td> +<td><code>-</code></td> <td>Location of the Xrefs to link to.<br /><b>Default value is</b>: <code>${project.reporting.outputDirectory}/xref</code>.<br /></td> </tr> @@ -651,7 +581,7 @@ passed to PMD to enable its type resolut <td><code>File</code></td> -<td><code>3.15.0</code></td> +<td><code>-</code></td> <td>Location of the Test Xrefs to link to.<br /><b>Default value is</b>: <code>${project.reporting.outputDirectory}/xref-test</code>.<br /></td> </tr> @@ -662,11 +592,9 @@ passed to PMD to enable its type resolut <section> <h4><a name="a.3Caggregate.3E"></a><b><a name="aggregate"><aggregate></a></b></h4> -<div><b>Deprecated.</b> since 3.15.0 Use the goals <code>pmd:aggregate-pmd</code> and -<code>pmd:aggregate-cpd</code> instead.</div> +<div><b>Deprecated.</b> since 3.15.0 Use the goals <code>pmd:aggregate-pmd</code> and <code>pmd:aggregate-cpd</code> instead.</div> -<div>Whether to build an aggregated report at the root, or build -individual reports.</div> +<div>Whether to build an aggregated report at the root, or build individual reports.</div> <ul> @@ -682,9 +610,7 @@ individual reports.</div> </ul><hr /></section><section> <h4><a name="a.3CanalysisCache.3E"></a><b><a name="analysisCache"><analysisCache></a></b></h4> -<div>Enables the analysis cache, which speeds up PMD. This requires a -cache file, that contains the results of the last PMD run. Thus the -cache is only effective, if this file is not cleaned between runs.</div> +<div>Enables the analysis cache, which speeds up PMD. This requires a cache file, that contains the results of the last PMD run. Thus the cache is only effective, if this file is not cleaned between runs.</div> <ul> @@ -700,12 +626,7 @@ cache is only effective, if this file is </ul><hr /></section><section> <h4><a name="a.3CanalysisCacheLocation.3E"></a><b><a name="analysisCacheLocation"><analysisCacheLocation></a></b></h4> -<div>The location of the analysis cache, if it is enabled. This file -contains the results of the last PMD run and must not be cleaned -between consecutive PMD runs. Otherwise the cache is not in use. If -the file doesn't exist, PMD executes as if there is no cache -enabled and all files are analyzed. Otherwise only changed files -will be analyzed again.</div> +<div>The location of the analysis cache, if it is enabled. This file contains the results of the last PMD run and must not be cleaned between consecutive PMD runs. Otherwise the cache is not in use. If the file doesn't exist, PMD executes as if there is no cache enabled and all files are analyzed. Otherwise only changed files will be analyzed again.</div> <ul> @@ -753,12 +674,11 @@ will be analyzed again.</div> </ul><hr /></section><section> <h4><a name="a.3CcompileSourceRoots.3E"></a><b><a name="compileSourceRoots"><compileSourceRoots></a></b></h4> -<div>Specifies the location of the source directories to be used for -PMD. Defaults to <code>project.compileSourceRoots</code>.</div> +<div>Specifies the location of the source directories to be used for PMD. Defaults to <code>project.compileSourceRoots</code>.</div> <ul> -<li><b>Type</b>: <code>java.util.List</code></li> +<li><b>Type</b>: <code>java.util.List<java.lang.String></code></li> <li><b>Since</b>: <code>3.7</code></li> @@ -768,10 +688,7 @@ PMD. Defaults to <code>project.compileSo </ul><hr /></section><section> <h4><a name="a.3CexcludeFromFailureFile.3E"></a><b><a name="excludeFromFailureFile"><excludeFromFailureFile></a></b></h4> -<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> +<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> @@ -797,17 +714,11 @@ duplicate.</div> </ul><hr /></section><section> <h4><a name="a.3Cexcludes.3E"></a><b><a name="excludes"><excludes></a></b></h4> -<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 <code>excludeRoots</code> -instead.</div> +<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 <code>excludeRoots</code> instead.</div> <ul> -<li><b>Type</b>: <code>java.util.List</code></li> +<li><b>Type</b>: <code>java.util.List<java.lang.String></code></li> <li><b>Since</b>: <code>2.2</code></li> @@ -815,82 +726,69 @@ instead.</div> </ul><hr /></section><section> <h4><a name="a.3Cformat.3E"></a><b><a name="format"><format></a></b></h4> -<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 produced in any case, since -this format is needed for the check goals (pmd:check, -pmd:aggregator-check, pmd:cpd-check, pmd:aggregator-cpd-check).</div> +<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 produced in any case, since this format is needed for the check goals (pmd:check, pmd:aggregator-check, pmd:cpd-check, pmd:aggregator-cpd-check).</div> <ul> <li><b>Type</b>: <code>java.lang.String</code></li> -<li><b>Since</b>: <code>3.15.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>format</code></li> <li><b>Default</b>: <code>xml</code></li> </ul><hr /></section><section> -<h4><a name="a.3CincludeTests.3E"></a><b><a name="includeTests"><includeTests></a></b></h4> +<h4><a name="a.3Cincludes.3E"></a><b><a name="includes"><includes></a></b></h4> -<div>Run PMD on the tests.</div> +<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>: <code>boolean</code></li> +<li><b>Type</b>: <code>java.util.List<java.lang.String></code></li> <li><b>Since</b>: <code>2.2</code></li> <li><b>Required</b>: <code>No</code></li> - -<li><b>Default</b>: <code>false</code></li> </ul><hr /></section><section> -<h4><a name="a.3CincludeXmlInSite.3E"></a><b><a name="includeXmlInSite"><includeXmlInSite></a></b></h4> +<h4><a name="a.3CincludeTests.3E"></a><b><a name="includeTests"><includeTests></a></b></h4> -<div>Whether to include the xml files generated by PMD/CPD in the site.</div> +<div>Run PMD on the tests.</div> <ul> <li><b>Type</b>: <code>boolean</code></li> -<li><b>Since</b>: <code>3.0</code></li> +<li><b>Since</b>: <code>2.2</code></li> <li><b>Required</b>: <code>No</code></li> <li><b>Default</b>: <code>false</code></li> </ul><hr /></section><section> -<h4><a name="a.3Cincludes.3E"></a><b><a name="includes"><includes></a></b></h4> +<h4><a name="a.3CincludeXmlInSite.3E"></a><b><a name="includeXmlInSite"><includeXmlInSite></a></b></h4> -<div>A list of files to include from checking. Can contain Ant-style -wildcards and double wildcards. Defaults to **\/*.java.</div> +<div>Whether to include the xml files generated by PMD/CPD in the site.</div> <ul> -<li><b>Type</b>: <code>java.util.List</code></li> +<li><b>Type</b>: <code>boolean</code></li> -<li><b>Since</b>: <code>2.2</code></li> +<li><b>Since</b>: <code>3.0</code></li> <li><b>Required</b>: <code>No</code></li> + +<li><b>Default</b>: <code>false</code></li> </ul><hr /></section><section> <h4><a name="a.3CjdkToolchain.3E"></a><b><a name="jdkToolchain"><jdkToolchain></a></b></h4> <div> -<p>Allow for configuration of the jvm used to run PMD via maven -toolchains. This permits a configuration where the project is built -with one jvm and PMD is executed with another. This overrules the -toolchain selected by the maven-toolchain-plugin.</p> +<p>Allow for configuration of the jvm used to run PMD via maven toolchains. This permits a configuration where the project is built with one jvm and PMD is executed with another. This overrules the toolchain selected by the maven-toolchain-plugin.</p> -<p>Examples:</p> -(see <a class="externalLink" href="https://maven.apache.org/guides/mini/guide-using-toolchains.html";>Guide -to Toolchains</a> for more info) +<p>Examples:</p> (see <a class="externalLink" href="https://maven.apache.org/guides/mini/guide-using-toolchains.html";> Guide to Toolchains</a> for more info) <div> <pre> <code> -<configuration> + <configuration> ... <jdkToolchain> <version>1.11</version> @@ -904,14 +802,12 @@ to Toolchains</a> for more info) <vendor>zulu</vendor> </jdkToolchain> </configuration> - </code> -</pre></div> - -<b>note:</b> requires at least Maven 3.3.1</div> + </code> +</pre></div> <b>note:</b> requires at least Maven 3.3.1</div> <ul> -<li><b>Type</b>: <code>java.util.Map</code></li> +<li><b>Type</b>: <code>java.util.Map<java.lang.String, java.lang.String></code></li> <li><b>Since</b>: <code>3.14.0</code></li> @@ -919,9 +815,7 @@ to Toolchains</a> for more info) </ul><hr /></section><section> <h4><a name="a.3Clanguage.3E"></a><b><a name="language"><language></a></b></h4> -<div>The programming language to be analyzed by PMD. Valid values are -currently <code>java</code>, <code>javascript</code> and -<code>jsp</code>.</div> +<div>The programming language to be analyzed by PMD. Valid values are currently <code>java</code>, <code>javascript</code> and <code>jsp</code>.</div> <ul> @@ -935,15 +829,12 @@ currently <code>java</code>, <code>javas </ul><hr /></section><section> <h4><a name="a.3ClinkXRef.3E"></a><b><a name="linkXRef"><linkXRef></a></b></h4> -<div>Link the violation line numbers to the source xref. Links will be -created automatically if the jxr plugin is being used.</div> +<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>: <code>boolean</code></li> -<li><b>Since</b>: <code>3.15.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>linkXRef</code></li> @@ -952,8 +843,7 @@ created automatically if the jxr plugin </ul><hr /></section><section> <h4><a name="a.3CminimumPriority.3E"></a><b><a name="minimumPriority"><minimumPriority></a></b></h4> -<div>The rule priority threshold; rules with lower priority than this -will not be evaluated.</div> +<div>The rule priority threshold; rules with lower priority than this will not be evaluated.</div> <ul> @@ -969,11 +859,7 @@ will not be evaluated.</div> </ul><hr /></section><section> <h4><a name="a.3CrenderProcessingErrors.3E"></a><b><a name="renderProcessingErrors"><renderProcessingErrors></a></b></h4> -<div>Also render processing errors into the HTML report. Processing -errors are problems, that PMD encountered while executing the -rules. It can be parsing errors or exceptions during rule -execution. Processing errors indicate a bug in PMD and the -information provided help in reporting and fixing bugs in PMD.</div> +<div>Also render processing errors into the HTML report. Processing errors are problems, that PMD encountered while executing the rules. It can be parsing errors or exceptions during rule execution. Processing errors indicate a bug in PMD and the information provided help in reporting and fixing bugs in PMD.</div> <ul> @@ -1005,8 +891,7 @@ information provided help in reporting a </ul><hr /></section><section> <h4><a name="a.3CrenderSuppressedViolations.3E"></a><b><a name="renderSuppressedViolations"><renderSuppressedViolations></a></b></h4> -<div>Add a section in the HTML report that lists the suppressed -violations.</div> +<div>Add a section in the HTML report that lists the suppressed violations.</div> <ul> @@ -1022,8 +907,7 @@ violations.</div> </ul><hr /></section><section> <h4><a name="a.3CrenderViolationsByPriority.3E"></a><b><a name="renderViolationsByPriority"><renderViolationsByPriority></a></b></h4> -<div>Add a section in the HTML report, that groups the found violations -by rule priority in addition to grouping by file.</div> +<div>Add a section in the HTML report, that groups the found violations by rule priority in addition to grouping by file.</div> <ul> @@ -1039,26 +923,19 @@ by rule priority in addition to grouping </ul><hr /></section><section> <h4><a name="a.3Crulesets.3E"></a><b><a name="rulesets"><rulesets></a></b></h4> -<div>The PMD rulesets to use. See the <a class="externalLink" href="https://pmd.github.io/latest/pmd_rules_java.html";>Stock Java -Rulesets</a> for a list of available rules. Defaults to a custom -ruleset provided by this maven plugin -(<code>/rulesets/java/maven-pmd-plugin-default.xml</code>).</div> +<div>The PMD rulesets to use. See the <a class="externalLink" href="https://pmd.github.io/latest/pmd_rules_java.html";>Stock Java Rulesets</a> for a list of available rules. Defaults to a custom ruleset provided by this maven plugin (<code>/rulesets/java/maven-pmd-plugin-default.xml</code>).</div> <ul> <li><b>Type</b>: <code>java.lang.String[]</code></li> -<li><b>Since</b>: <code>3.15.0</code></li> - <li><b>Required</b>: <code>No</code></li> </ul><hr /></section><section> <h4><a name="a.3CrulesetsTargetDirectory.3E"></a><b><a name="rulesetsTargetDirectory"><rulesetsTargetDirectory></a></b></h4> -<div>Before PMD is executed, the configured rulesets are resolved and -copied into this directory. +<div>Before PMD is executed, the configured rulesets are resolved and copied into this directory. -<p>Note: Before 3.13.0, this was by default -${project.build.directory}.</p></div> +<p>Note: Before 3.13.0, this was by default ${project.build.directory}.</p></div> <ul> @@ -1074,11 +951,7 @@ ${project.build.directory}.</p></div> </ul><hr /></section><section> <h4><a name="a.3CshowPmdLog.3E"></a><b><a name="showPmdLog"><showPmdLog></a></b></h4> -<div>Redirect PMD log into maven log out. When enabled, the PMD log -output is redirected to maven, so that it is visible in the console -together with all the other log output. Also, if maven is started -with the debug flag (<code>-X</code> or <code>--debug</code>), the -PMD logger is also configured for debug.</div> +<div>Redirect PMD log into maven log out. When enabled, the PMD log output is redirected to maven, so that it is visible in the console together with all the other log output. Also, if maven is started with the debug flag (<code>-X</code> or <code>--debug</code>), the PMD logger is also configured for debug.</div> <ul> @@ -1094,8 +967,7 @@ PMD logger is also configured for debug. </ul><hr /></section><section> <h4><a name="a.3Cskip.3E"></a><b><a name="skip"><skip></a></b></h4> -<div>Skip the PMD report generation. Most useful on the command line via -"-Dpmd.skip=true".</div> +<div>Skip the PMD report generation. Most useful on the command line via "-Dpmd.skip=true".</div> <ul> @@ -1111,11 +983,9 @@ PMD logger is also configured for debug. </ul><hr /></section><section> <h4><a name="a.3CskipEmptyReport.3E"></a><b><a name="skipEmptyReport"><skipEmptyReport></a></b></h4> -<div>Skip the PMD/CPD report generation if there are no violations or -duplications found. Defaults to <code>false</code>. +<div>Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults to <code>false</code>. -<p>Note: the default value was changed from <code>true</code> to -<code>false</code> with version 3.13.0.</p></div> +<p>Note: the default value was changed from <code>true</code> to <code>false</code> with version 3.13.0.</p></div> <ul> @@ -1145,10 +1015,7 @@ duplications found. Defaults to <code>fa </ul><hr /></section><section> <h4><a name="a.3CsuppressMarker.3E"></a><b><a name="suppressMarker"><suppressMarker></a></b></h4> -<div>Source level marker used to indicate whether a RuleViolation should -be suppressed. If it is not set, PMD's default will be used, which -is <code>NOPMD</code>. See also <a class="externalLink" href="https://pmd.github.io/latest/pmd_userdocs_suppressing_warnings.html";>PMD -- Suppressing warnings</a>.</div> +<div>Source level marker used to indicate whether a RuleViolation should be suppressed. If it is not set, PMD's default will be used, which is <code>NOPMD</code>. See also <a class="externalLink" href="https://pmd.github.io/latest/pmd_userdocs_suppressing_warnings.html";>PMD – Suppressing warnings</a>.</div> <ul> @@ -1168,35 +1035,22 @@ is <code>NOPMD</code>. See also <a class <li><b>Type</b>: <code>java.io.File</code></li> -<li><b>Since</b>: <code>3.15.0</code></li> - <li><b>Required</b>: <code>Yes</code></li> <li><b>User Property</b>: <code>project.build.directory</code></li> </ul><hr /></section><section> <h4><a name="a.3CtargetJdk.3E"></a><b><a name="targetJdk"><targetJdk></a></b></h4> -<div>The target JDK to analyze based on. Should match the source used in -the compiler plugin. Valid values with the default PMD version are -currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code>, -<code>1.6</code>, <code>1.7</code>, <code>1.8</code>, -<code>9</code>, <code>10</code>, <code>11</code>, <code>12</code>, -<code>13</code>, <code>14</code>, <code>15</code>, <code>16</code>, -<code>17</code>, <code>18</code>, and <code>19</code>. +<div>The target JDK to analyze based on. Should match the source used in the compiler plugin. Valid values with the default PMD version are currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code>, <code>1.6</code>, <code>1.7</code>, <code>1.8</code>, <code>9</code>, <code>10</code>, <code>11</code>, <code>12</code>, <code>13</code>, <code>14</code>, <code>15</code>, <code>16</code>, <code>17</code>, <code>18</code>, <code>19</code>, and <code>20</code>. -<p>You can override the default PMD version by specifying PMD as a -dependency, see <a href="examples/upgrading-PMD-at-runtime.html">Upgrading PMD at -Runtime</a>.</p> +<p>You can override the default PMD version by specifying PMD as a dependency, see <a href="examples/upgrading-PMD-at-runtime.html">Upgrading PMD at Runtime</a>.</p> -<p><b>Note:</b> this parameter is only used if the language -parameter is set to <code>java</code>.</p></div> +<p><b>Note:</b> this parameter is only used if the language parameter is set to <code>java</code>.</p></div> <ul> <li><b>Type</b>: <code>java.lang.String</code></li> -<li><b>Since</b>: <code>3.15.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>targetJdk</code></li> @@ -1205,12 +1059,11 @@ parameter is set to <code>java</code>.</ </ul><hr /></section><section> <h4><a name="a.3CtestSourceRoots.3E"></a><b><a name="testSourceRoots"><testSourceRoots></a></b></h4> -<div>The directories containing the test-sources to be used for PMD. -Defaults to <code>project.testCompileSourceRoots</code></div> +<div>The directories containing the test-sources to be used for PMD. Defaults to <code>project.testCompileSourceRoots</code></div> <ul> -<li><b>Type</b>: <code>java.util.List</code></li> +<li><b>Type</b>: <code>java.util.List<java.lang.String></code></li> <li><b>Since</b>: <code>3.7</code></li> @@ -1220,8 +1073,7 @@ Defaults to <code>project.testCompileSou </ul><hr /></section><section> <h4><a name="a.3CtypeResolution.3E"></a><b><a name="typeResolution"><typeResolution></a></b></h4> -<div>Controls whether the project's compile/test classpath should be -passed to PMD to enable its type resolution feature.</div> +<div>Controls whether the project's compile/test classpath should be passed to PMD to enable its type resolution feature.</div> <ul> @@ -1243,8 +1095,6 @@ passed to PMD to enable its type resolut <li><b>Type</b>: <code>java.io.File</code></li> -<li><b>Since</b>: <code>3.15.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>Default</b>: <code>${project.reporting.outputDirectory}/xref</code></li> @@ -1257,8 +1107,6 @@ passed to PMD to enable its type resolut <li><b>Type</b>: <code>java.io.File</code></li> -<li><b>Since</b>: <code>3.15.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>Default</b>: <code>${project.reporting.outputDirectory}/xref-test</code></li>
