Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/cpd-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/cpd-mojo.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/cpd-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/cpd-mojo.xml at 2023-01-06 + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target\generated-site\xdoc/cpd-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:cpd</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,16 +126,13 @@ <p><b>Full name</b>:</p> -<p>org.apache.maven.plugins:maven-pmd-plugin:3.20.0:cpd</p> +<p>org.apache.maven.plugins:maven-pmd-plugin:3.21.0:cpd</p> <p><b>Description</b>:</p> -<div>Creates a report for PMD's Copy/Paste Detector (CPD) tool. It can -also generate a cpd results file in any of these formats: xml, csv -or txt. +<div>Creates a report for PMD's Copy/Paste Detector (CPD) tool. It can also generate a cpd results file in any of these formats: xml, csv or txt. -<p>See <a class="externalLink" href="https://pmd.github.io/latest/pmd_userdocs_cpd.html";>Finding -duplicated code</a> for more details.</p></div> +<p>See <a class="externalLink" href="https://pmd.github.io/latest/pmd_userdocs_cpd.html";>Finding duplicated code</a> for more details.</p></div> <p><b>Attributes</b>:</p> @@ -169,7 +166,7 @@ duplicated code</a> for more details.</p <td><code>File</code></td> -<td><code>2.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> @@ -199,20 +196,18 @@ duplicated code</a> for more details.</p <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"> <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"> @@ -223,10 +218,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"> @@ -244,17 +236,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"> @@ -263,14 +249,9 @@ instead.<br /></td> <td><code>String</code></td> -<td><code>2.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"> @@ -292,8 +273,7 @@ pmd:aggregator-check, pmd:cpd-check, pmd <td><code>2.5</code></td> -<td>Similar to <code>ignoreLiterals</code> but for identifiers; i.e., -variable names, methods names, and so forth.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>cpd.ignoreIdentifiers</code>.<br /></td> +<td>Similar to <code>ignoreLiterals</code> but for identifiers; i.e., variable names, methods names, and so forth.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>cpd.ignoreIdentifiers</code>.<br /></td> </tr> <tr class="b"> @@ -304,69 +284,59 @@ variable names, methods names, and so fo <td><code>2.5</code></td> -<td>If true, CPD ignores literal value differences when evaluating a -duplicate block. This means that <code>foo=42;</code> and -<code>foo=43;</code> 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>: <code>false</code>.<br /><b>User property is</b>: <code>cpd.ignoreLiterals</code>.<br /></td> +<td>If true, CPD ignores literal value differences when evaluating a duplicate block. This means that <code>foo=42;</code> and <code>foo=43;</code> 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>: <code>false</code>.<br /><b>User property is</b>: <code>cpd.ignoreLiterals</code>.<br /></td> </tr> <tr class="a"> -<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="b"> -<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="a"> -<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="b"> <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>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>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) <div> <pre> <code> -<configuration> + <configuration> ... <jdkToolchain> <version>1.11</version> @@ -380,10 +350,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="a"> @@ -394,9 +362,7 @@ to Toolchains</a> for more info) <td><code>3.5</code></td> -<td>The programming language to be analyzed by CPD. Valid values are -currently <code>java</code>, <code>javascript</code> or -<code>jsp</code>.<br /><b>Default value is</b>: <code>java</code>.<br /></td> +<td>The programming language to be analyzed by CPD. Valid values are currently <code>java</code>, <code>javascript</code> or <code>jsp</code>.<br /><b>Default value is</b>: <code>java</code>.<br /></td> </tr> <tr class="b"> @@ -405,10 +371,9 @@ currently <code>java</code>, <code>javas <td><code>boolean</code></td> -<td><code>2.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="a"> @@ -417,10 +382,9 @@ created automatically if the jxr plugin <td><code>int</code></td> -<td><code>2.0</code></td> +<td><code>-</code></td> -<td>The minimum number of tokens that need to be duplicated before it -causes a violation.<br /><b>Default value is</b>: <code>100</code>.<br /><b>User property is</b>: <code>minimumTokens</code>.<br /></td> +<td>The minimum number of tokens that need to be duplicated before it causes a violation.<br /><b>Default value is</b>: <code>100</code>.<br /><b>User property is</b>: <code>minimumTokens</code>.<br /></td> </tr> <tr class="b"> @@ -431,11 +395,7 @@ causes a violation.<br /><b>Default valu <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="a"> @@ -446,8 +406,7 @@ PMD logger is also configured for debug. <td><code>2.1</code></td> -<td>Skip the CPD report generation. Most useful on the command line via -"-Dcpd.skip=true".<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>cpd.skip</code>.<br /></td> +<td>Skip the CPD report generation. Most useful on the command line via "-Dcpd.skip=true".<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>cpd.skip</code>.<br /></td> </tr> <tr class="b"> @@ -458,23 +417,20 @@ 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="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"> @@ -483,7 +439,7 @@ Defaults to <code>project.testCompileSou <td><code>File</code></td> -<td><code>2.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> @@ -494,7 +450,7 @@ Defaults to <code>project.testCompileSou <td><code>File</code></td> -<td><code>2.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> @@ -505,11 +461,9 @@ Defaults to <code>project.testCompileSou <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> @@ -525,12 +479,11 @@ individual reports.</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> @@ -540,10 +493,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> @@ -569,17 +519,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> @@ -587,19 +531,12 @@ 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>2.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>format</code></li> @@ -624,8 +561,7 @@ pmd:aggregator-check, pmd:cpd-check, pmd </ul><hr /></section><section> <h4><a name="a.3CignoreIdentifiers.3E"></a><b><a name="ignoreIdentifiers"><ignoreIdentifiers></a></b></h4> -<div>Similar to <code>ignoreLiterals</code> but for identifiers; i.e., -variable names, methods names, and so forth.</div> +<div>Similar to <code>ignoreLiterals</code> but for identifiers; i.e., variable names, methods names, and so forth.</div> <ul> @@ -641,11 +577,7 @@ variable names, methods names, and so fo </ul><hr /></section><section> <h4><a name="a.3CignoreLiterals.3E"></a><b><a name="ignoreLiterals"><ignoreLiterals></a></b></h4> -<div>If true, CPD ignores literal value differences when evaluating a -duplicate block. This means that <code>foo=42;</code> and -<code>foo=43;</code> 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> +<div>If true, CPD ignores literal value differences when evaluating a duplicate block. This means that <code>foo=42;</code> and <code>foo=43;</code> 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> @@ -659,63 +591,57 @@ see what it turns up.</div> <li><b>Default</b>: <code>false</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>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>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) <div> <pre> <code> -<configuration> + <configuration> ... <jdkToolchain> <version>1.11</version> @@ -729,14 +655,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> @@ -744,9 +668,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 CPD. Valid values are -currently <code>java</code>, <code>javascript</code> or -<code>jsp</code>.</div> +<div>The programming language to be analyzed by CPD. Valid values are currently <code>java</code>, <code>javascript</code> or <code>jsp</code>.</div> <ul> @@ -760,15 +682,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>2.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>linkXRef</code></li> @@ -777,15 +696,12 @@ created automatically if the jxr plugin </ul><hr /></section><section> <h4><a name="a.3CminimumTokens.3E"></a><b><a name="minimumTokens"><minimumTokens></a></b></h4> -<div>The minimum number of tokens that need to be duplicated before it -causes a violation.</div> +<div>The minimum number of tokens that need to be duplicated before it causes a violation.</div> <ul> <li><b>Type</b>: <code>int</code></li> -<li><b>Since</b>: <code>2.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>User Property</b>: <code>minimumTokens</code></li> @@ -794,11 +710,7 @@ causes a violation.</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> @@ -814,8 +726,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 CPD report generation. Most useful on the command line via -"-Dcpd.skip=true".</div> +<div>Skip the CPD report generation. Most useful on the command line via "-Dcpd.skip=true".</div> <ul> @@ -831,11 +742,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> @@ -855,20 +764,17 @@ duplications found. Defaults to <code>fa <li><b>Type</b>: <code>java.io.File</code></li> -<li><b>Since</b>: <code>2.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.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> @@ -884,8 +790,6 @@ Defaults to <code>project.testCompileSou <li><b>Type</b>: <code>java.io.File</code></li> -<li><b>Since</b>: <code>2.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>Default</b>: <code>${project.reporting.outputDirectory}/xref</code></li> @@ -898,8 +802,6 @@ Defaults to <code>project.testCompileSou <li><b>Type</b>: <code>java.io.File</code></li> -<li><b>Since</b>: <code>2.0</code></li> - <li><b>Required</b>: <code>No</code></li> <li><b>Default</b>: <code>${project.reporting.outputDirectory}/xref-test</code></li>
Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/cpd.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/cpd.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/cpd.html Fri May 12 20:25:56 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-pmd-plugin:3.20.0:cpd at 2023-01-06 + | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-pmd-plugin:3.21.0:cpd 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 ">CPD Results</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> @@ -91,7 +91,6 @@ <li><a href="xref-test/index.html" title="Test Source Xref"><span class="none"></span>Test Source Xref</a></li> <li><a href="taglist.html" title="Tag List"><span class="none"></span>Tag List</a></li> <li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li> - <li><a href="testapidocs/index.html" title="Test Javadoc"><span class="none"></span>Test Javadoc</a></li> <li><a href="plugin-info.html" title="Plugin Documentation"><span class="none"></span>Plugin Documentation</a></li> <li><a href="invoker-report.html" title="Invoker Build Results"><span class="none"></span>Invoker Build Results</a></li> </ul></li> @@ -131,9 +130,8 @@ </header> <main id="bodyColumn" class="span10" > <section> -<h2><a name="CPD_Results"></a>CPD Results</h2> -<p>The following document contains the results of PMD's <a class="externalLink" href="https://pmd.github.io/latest/pmd_userdocs_cpd.html";>CPD</a> 6.53.0.</p></section><section> -<h2><a name="Duplications"></a>Duplications</h2> +<h2><a name="CPD_Results"></a>CPD Results</h2><a name="CPD_Results"></a> +<p>The following document contains the results of PMD's <a class="externalLink" href="https://pmd.github.io/latest/pmd_userdocs_cpd.html";>CPD</a> 6.55.0.</p> <p>CPD found no problems in your source code.</p></section> </main> </div>
