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

Add an anchor to each option on javadoc man page

    XMLWordPrintable

Details

    • Task
    • Status: Resolved
    • P4
    • Resolution: Fixed
    • 18
    • 19
    • tools

    Backports

      Description

        Providing anchors for each option on the javadoc man page can help when needing to reference an option from external documentation or content.

        The javac page already does this: https://docs.oracle.com/en/java/javase/18/docs/specs/man/javac.html#option-class-path

        Following its precedent and for consistency the anchors should follow the `option-[option-name]` format, e.g. option-breakiterator.

        For non-URL compliant characters in an option, if applicable, should be replaced with a `-`.

        Attachments

          Issue Links

            backported by

            Backport - A issue that is required to port a Bug or Feature into another product release. This issue type is generally associated with the main Bug/Feature to represent each individual release of the port. JDK-8289236 Add an anchor to each option on javadoc man page

            • P4 - Minor loss of function, or other problem where easy workaround is present.
            • Resolved

            Backport - A issue that is required to port a Bug or Feature into another product release. This issue type is generally associated with the main Bug/Feature to represent each individual release of the port. JDK-8291073 Add an anchor to each option on javadoc man page

            • P4 - Minor loss of function, or other problem where easy workaround is present.
            • Resolved

            Backport - A issue that is required to port a Bug or Feature into another product release. This issue type is generally associated with the main Bug/Feature to represent each individual release of the port. JDK-8291166 Add an anchor to each option on javadoc man page

            • P4 - Minor loss of function, or other problem where easy workaround is present.
            • Resolved

            Activity

              People

                jjg Jonathan Gibbons
                bkorando Billy Korando
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: