RFR: 8323698: Class use page does not include extends/implements type arguments [v5]

Chen Liang liach at openjdk.org
Fri Feb 23 05:36:55 UTC 2024


On Thu, 22 Feb 2024 13:26:34 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains eight additional commits since the last revision:
>> 
>>  - Distinguish subinterfaces, use clearer terms
>>  - Merge branch 'master' of https://github.com/openjdk/jdk into feature/jd-use-super-typearg
>>  - Review changes
>>  - Merge branch 'master' of https://github.com/openjdk/jdk into feature/jd-use-super-typearg
>>  - Fix tests
>>  - Improve localization
>>  - Merge branch 'master' of https://github.com/openjdk/jdk into feature/jd-use-super-typearg
>>  - Use page to check extends/implements type arguments
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties line 286:
> 
>> 284:     subclasses with parameters of type A.  \
>> 285:     You can access this page by first going to the package, class or interface, then clicking on \
>> 286:     the USE link in the navigation bar.
> 
> Thanks for catching this! Consider this wording:
> 
> 
> doclet.help.use.body=\
>     Each documented package, class or interface has its own Use page, which lists \
>     packages, classes, interfaces, methods, constructors and fields that use any \
>     part of that package, class or interface. Given a class or interface A, its \
>     Use page includes subclasses or subinterfaces of A, fields declared as A, \
>     methods that return A, methods and constructors with parameters of type A, \
>     and subclasses or subinterfaces with parameters of type A. You can access \
>     this page by first going to the package, class or interface, then clicking \
>     on the USE link in the navigation bar.
> 
> 
> There are a couple of other issues there which should be fixed in a separate PR.

This is an improvement. Applying as I don't see any problem in your wording. ("class or interface" is an established term)

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

PR Review Comment: https://git.openjdk.org/jdk/pull/17414#discussion_r1500226393


More information about the javadoc-dev mailing list