-
Enhancement
-
Resolution: Fixed
-
P4
-
8
-
None
-
b03
-
generic
-
generic
There is a number of relatively easy changes that can be done to make the sections for inherited members in class and interface documentation more useful:
- The link to the class or interface declaring the inherited members currently directs to the top of the page. The link should target the type's member summary for the kind of members documented by the local inherited member section.
- The link to the declaring class/interface is prefixed by the package name. This makes the heading very verbose and is not very useful in this context.
- Sections for inherited methods use just the method name as link labels. This is nice as it makes the list short and readable, but it leaves the user wondering especially for overloaded methods. We could add the method signature as title attribute which is shown as tooltip on hover by some browsers.
- Sections for inherited nested classes show linked type parameters and bounds. This is too much information in this context. We should only show but not link type parameters and omit bounds, like we do for subinterfaces/-classes at the top of the page.
- The link to the class or interface declaring the inherited members currently directs to the top of the page. The link should target the type's member summary for the kind of members documented by the local inherited member section.
- The link to the declaring class/interface is prefixed by the package name. This makes the heading very verbose and is not very useful in this context.
- Sections for inherited methods use just the method name as link labels. This is nice as it makes the list short and readable, but it leaves the user wondering especially for overloaded methods. We could add the method signature as title attribute which is shown as tooltip on hover by some browsers.
- Sections for inherited nested classes show linked type parameters and bounds. This is too much information in this context. We should only show but not link type parameters and omit bounds, like we do for subinterfaces/-classes at the top of the page.
- links to
-
Commit(master) openjdk/jdk/f71d5150
-
Review(master) openjdk/jdk/22651