This is an automated email from the ASF dual-hosted git repository. adangel pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-pmd-plugin.git
commit 867ca0b75c2a32c3a2b66613d30b3e1ab5f51418 Author: Andreas Dangel <[email protected]> AuthorDate: Fri Jan 8 10:31:41 2021 +0100 [MPMD-313] Improve <jdkToolchain> parameter description --- .../maven/plugins/pmd/AbstractPmdReport.java | 27 +++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java b/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java index 15bb1cd..ab8550d 100644 --- a/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java +++ b/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java @@ -224,9 +224,34 @@ public abstract class AbstractPmdReport /** * <p> - * Specify the requirements for this jdk toolchain. + * 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 href="https://maven.apache.org/guides/mini/guide-using-toolchains.html";> + * Guide to Toolchains</a> for more info) + * + * <pre> + * {@code + * <configuration> + * ... + * <jdkToolchain> + * <version>1.11</version> + * </jdkToolchain> + * </configuration> + * + * <configuration> + * ... + * <jdkToolchain> + * <version>1.8</version> + * <vendor>zulu</vendor> + * </jdkToolchain> + * </configuration> + * } + * </pre> + * * <strong>note:</strong> requires at least Maven 3.3.1 * * @since 3.14.0
