RFR: 8345777: Improve sections for inherited members
Hannes Wallnöfer
hannesw at openjdk.org
Mon Dec 9 17:45:49 UTC 2024
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
-------------
Commit messages:
- 8345777: Improve sections for inherited members
Changes: https://git.openjdk.org/jdk/pull/22651/files
Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22651&range=00
Issue: https://bugs.openjdk.org/browse/JDK-8345777
Stats: 203 lines in 16 files changed: 72 ins; 46 del; 85 mod
Patch: https://git.openjdk.org/jdk/pull/22651.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/22651/head:pull/22651
PR: https://git.openjdk.org/jdk/pull/22651
More information about the javadoc-dev
mailing list