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

Jonathan Gibbons jjg at openjdk.java.net
Wed Feb 9 19:18:39 UTC 2022


On Wed, 9 Feb 2022 16:37:00 GMT, Christian Stein <cstein at openjdk.org> wrote:

> A number of modules declare that the "provide" ToolProvider.
> 
> These modules now specify the "name" of the argument used by `ToolProvider.findFirst` to access an instance of the tool provider within the description part of a `@provides` API tag.

Minor format suggestion:  add a newline after the service name, to start the description on its own line, as in:


@provides <service-name>
        <description>


This form would extend well to any modules that provide the service in different ways ... i.e. with different names for `TP.findFirst` to obtain different instances.

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

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


More information about the core-libs-dev mailing list