You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2021/04/25 09:34:32 UTC
[maven-javadoc-plugin] branch master updated: [MJAVADOC-668]
Improve parameter description
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 1bdcb93 [MJAVADOC-668] Improve <jdkToolchain> parameter description
1bdcb93 is described below
commit 1bdcb9335f987a3a570e11775371217b1c01876c
Author: rfscholte <rf...@apache.org>
AuthorDate: Sun Apr 25 11:34:10 2021 +0200
[MJAVADOC-668] Improve <jdkToolchain> parameter description
---
.../maven/plugins/javadoc/AbstractJavadocMojo.java | 26 +++++++++++++++++++++-
.../maven/plugins/javadoc/JavadocVersionTest.java | 3 +--
2 files changed, 26 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
index 10e3168..7f75eb8 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
@@ -1726,9 +1726,33 @@ public abstract class AbstractJavadocMojo
/**
* <p>
- * Specify the requirements for this jdk toolchain.
+ * Allow for configuration of the javadoc tool via maven toolchains.
* 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>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.0.0
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/JavadocVersionTest.java b/src/test/java/org/apache/maven/plugins/javadoc/JavadocVersionTest.java
index ac63c24..2aa6ff4 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/JavadocVersionTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/JavadocVersionTest.java
@@ -30,10 +30,9 @@ public class JavadocVersionTest
{
/**
* Parsing is lazy, only triggered when comparing
- *
- * @noinspection deprecation
*/
@Test
+ @SuppressWarnings("deprecation")
public void testParse()
{
assertThat( JavadocVersion.parse( "1.4" ) )