[
https://issues.apache.org/jira/browse/MJAVADOC-668?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Marcono1234 updated MJAVADOC-668:
---------------------------------
Description:
As pointed out in [this
comment|https://issues.apache.org/jira/browse/MJAVADOC-500?focusedCommentId=16804678&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-16804678]
on MJAVADOC-500 it would be good to improve the {{<jdkToolchain>}} parameter
documentation.
The [current
documentation|https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#jdkToolchain]
only mentions that it represents "requirements for this jdk toolchain", but it
is not exactly clear what the syntax for these requirements is, or to what they
apply.
It might be good to use Surefire's
[documentation|https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html#jdkToolchain]
as reference, which hints that the {{<jdkToolchain>}} specifies the
requirements for the {{<provides>}} values of the JDK toolchains.
was:
As pointed out in [this
comment|https://issues.apache.org/jira/browse/MJAVADOC-500?focusedCommentId=16804678&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-16804678]
on MJAVADOC-500 it would be good to improve the {{<jdkToolchain>}} parameter
documentation.
The [current
documentation|https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#jdkToolchain]
does not mention how to use it, it only mentions that the value type is
{{java.util.Map}}, which is not very helpful.
It might be good to use Surefire's
[documentation|https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html#jdkToolchain]
as reference, which hints that the {{<jdkToolchain>}} specifies the
requirements for the {{<provides>}} values of the JDK toolchains.
> Improve <jdkToolchain> parameter description
> --------------------------------------------
>
> Key: MJAVADOC-668
> URL: https://issues.apache.org/jira/browse/MJAVADOC-668
> Project: Maven Javadoc Plugin
> Issue Type: Improvement
> Reporter: Marcono1234
> Priority: Minor
>
> As pointed out in [this
> comment|https://issues.apache.org/jira/browse/MJAVADOC-500?focusedCommentId=16804678&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-16804678]
> on MJAVADOC-500 it would be good to improve the {{<jdkToolchain>}} parameter
> documentation.
> The [current
> documentation|https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#jdkToolchain]
> only mentions that it represents "requirements for this jdk toolchain", but
> it is not exactly clear what the syntax for these requirements is, or to what
> they apply.
> It might be good to use Surefire's
> [documentation|https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html#jdkToolchain]
> as reference, which hints that the {{<jdkToolchain>}} specifies the
> requirements for the {{<provides>}} values of the JDK toolchains.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
