RFR: 8280825: Modules that "provide" ToolProvider should document the name that can be used

[Christian Stein]

On Thu, 10 Feb 2022 02:19:36 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> src/jdk.jartool/share/classes/module-info.java line 45:
>> 
>>> 43:  *         Pass {@code "jar"} as the name to
>>> 44:  *         {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
>>> 45:  *         in order to obtain an instance of the tool.
>> 
>> I'm not sure about the wording. It might be better to say that it provides a tool named "jar". Invoke findFirst("jar") to create an instance of this tool.
>
> What is "it" in "it provides..." ?

Perhaps like this?


/**
 * ...
 * @provides java.util.spi.ToolProvider
 *         Module {@code jdk.jartool} provides a tool named {@code "jar"}.
 *         Invoke {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst("jar")}
 *         to create an instance of this tool.
 * ...
 */

-------------

PR: https://git.openjdk.java.net/jdk/pull/7406