-
Enhancement
-
Resolution: Fixed
-
P4
-
20
-
None
-
generic
-
generic
There are many places where we render type parameters as extra links when linking to generic types in JavaDoc. These places include the Index pages, the All Classes page, the Constant Summary page as well as the Nested Classes section in a type documentation page.
In all of the above cases, the extra link on the type parameters does not add any additional value as it refers to the same URL as the main link. This is because documentation of type parameters is located near the top of the type documentation and does not have a dedicated id/anchor to link to.
There are several possible ways to improve this:
- Add an id attribute/anchor to the type parameter documentation to be used in type parameter links
- Provide some sort of highlighting of type parameter documentation when it is the target of a link, similar to what we currently do for search tags and system properties (see attached screenshot for example rendering)
- Omit type parameter links when linking to the same type in the main link
In all of the above cases, the extra link on the type parameters does not add any additional value as it refers to the same URL as the main link. This is because documentation of type parameters is located near the top of the type documentation and does not have a dedicated id/anchor to link to.
There are several possible ways to improve this:
- Add an id attribute/anchor to the type parameter documentation to be used in type parameter links
- Provide some sort of highlighting of type parameter documentation when it is the target of a link, similar to what we currently do for search tags and system properties (see attached screenshot for example rendering)
- Omit type parameter links when linking to the same type in the main link
- relates to
-
JDK-8313931 Javadoc: links to type parameters actually generate links to classes
- Resolved