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

Add specification for Javadoc search feature

    Details

    • Type: CSR
    • Status: Closed
    • Priority: P3
    • Resolution: Approved
    • Fix Version/s: 13
    • Component/s: tools
    • Labels:
      None
    • Subcomponent:
    • Compatibility Kind:
      behavioral
    • Compatibility Risk:
      minimal
    • Compatibility Risk Description:
      The specification is for a feature in the user interface of HTML pages generated by Javadoc.
    • Interface Kind:
      Other
    • Scope:
      JDK

      Description

      Summary

      Add a specification for the behavior of Javadoc search feature.

      Problem

      The search feature was added to Javadoc in JDK 9 with JEP 225, but the JEP only contained a very coarse description of how the search feature should work. Additionally, several shortcomings were found in the search implementation over time. These were addressed in JDK-8220497, and the changed behaviour should be documented.

      Solution

      Add a detailed specification of the Javadoc search feature that describes its behaviour in detail, including the changes introduced by JDK-8220497.

      Specification

      The content of the specification can be previewed at http://cr.openjdk.java.net/~hannesw/8178982/spec.02/javadoc-search-update.html. A markdown version of this file is also attached to this issue.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                hannesw Hannes Wallnoefer
                Reporter:
                bpatel Bhavesh Patel (Inactive)
                Reviewed By:
                Jonathan Gibbons
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: