Integrated: 8345777: Improve sections for inherited members

Hannes Wallnöfer hannesw at openjdk.org
Thu Dec 12 13:31:42 UTC 2024


On Mon, 9 Dec 2024 17:40:48 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> Please review a set of changes to make the sections for inherited members in API docs more usable. 
> 
>  - Link to the relevant member summary in the parent type instead of the top of the page in headings for inherited members
>  - Omit parent type's package name in headings for inherited members
>  - Add method signature as title attribute (tooltip) in links to inherited methods
>  - Omit type bounds and do not create separate links for type parameters in links to inherited nested classes
> 
> Before/after comparisons for methods and nested classes (the first two items also apply to other kinds of members):
> 
> java.util.TreeMap:
> -  inherited nested classes [before][1], [after][2]
> -  inherited methods [before][3], [after][4]
> 
> java.util.Spliterator.OfInt:
>  - inherited nested classes [before][5], [after][6]
>  - inherited  methods [before][7], [after][8]
> 
> [1]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#nested-class-summary
> [2]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#nested-class-summary
> 
> [3]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap
> [4]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap
> 
> [5]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#nested-class-summary
> [6]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#nested-class-summary
> 
> [7]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator
> [8]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator

This pull request has now been integrated.

Changeset: f71d5150
Author:    Hannes Wallnöfer <hannesw at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/f71d51502673bc95d66aa568e98e4801613497a5
Stats:     199 lines in 16 files changed: 72 ins; 46 del; 81 mod

8345777: Improve sections for inherited members

Reviewed-by: prappo

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

PR: https://git.openjdk.org/jdk/pull/22651


More information about the javadoc-dev mailing list