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

[Lance Andersen]

On Thu, 10 Feb 2022 03:04:43 GMT, Christian Stein <cstein at openjdk.org> wrote:

>> 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.
>  * ...
>  */

> Perhaps like this?
> 
> ```java
> /**
>  * ...
>  * @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.
>  * ...
>  */
> ```

What about

`Module {@code jdk.jartool) provides the equivalent of command-line access to the {@code "jar"} tool`

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

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