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

Support searching for sections in class/package javadoc

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: New
    • Priority: P3
    • Resolution: Unresolved
    • Affects Version/s: 19
    • Fix Version/s: None
    • Component/s: tools
    • Labels:
      None

      Description

      A class's javadoc often contains a lot of useful information. For instance the Signature Polymorphism section [1] in the class's javadoc of the MethodHandle class, is relevant in several different cases outside of this class as well.

      Another example is the section on Reachability in the java.lang.ref package javadoc. [2]

      However, the javadoc search feature currently doesn't support searching for these sections.

      It would be nice if these sections could be found through searches as well. Perhaps anything with a <h> tag, or anything with an explicit <a> tag, although the latter would require updating in many places to make things searchable (since most sections don't seem to have explicit <a> tags).

      [1]: https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/invoke/MethodHandle.html#sigpoly
      [2]: https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/ref/package-summary.html

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            jvernee Jorn Vernee
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: