[jira] [Created] (MCOMPILER-449) Improve parameter description

["Marcono1234 (Jira)" <ji...@apache.org>]

Marcono1234 created MCOMPILER-449:
-------------------------------------

             Summary: Improve <jdkToolchain> parameter description
                 Key: MCOMPILER-449
                 URL: https://issues.apache.org/jira/browse/MCOMPILER-449
             Project: Maven Compiler Plugin
          Issue Type: Improvement
            Reporter: Marcono1234


Similar to MJAVADOC-668, it would be good to improve the {{<jdkToolchain>}} parameter documentation.
The [current documentation|https://maven.apache.org/plugins/maven-compiler-plugin/compile-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.

Additionally it would be good to improve the page "[Compiling Sources Using A Different JDK|https://maven.apache.org/plugins/maven-compiler-plugin/examples/compile-using-different-jdk.html]" which _does_ mention that "it is also possible to give the plugin its own toolchain". But it does not refer or link to {{<jdkToolchain>}}, so it is not directly obvious how to achieve this.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)