Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8302449

Issues with type parameters links in generic type links

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Fixed
    • P4
    • 22
    • 20
    • tools
    • None

    Description

      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

      Attachments

        Issue Links

          There are no Sub-Tasks for this issue.

          Activity

            People

              hannesw Hannes Wallnoefer
              hannesw Hannes Wallnoefer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: