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

Remove javadoc support for HTML 4.

    XMLWordPrintable

    Details

    • Type: CSR
    • Status: Closed
    • Priority: P3
    • Resolution: Approved
    • Fix Version/s: 13
    • Component/s: tools
    • Labels:
      None
    • Subcomponent:
    • Compatibility Kind:
      behavioral
    • Compatibility Risk:
      low
    • Compatibility Risk Description:
      This will affect anyone who is still generating docs in HTML 4 format. Users may have to modify their documentation comments if they utilize features that are no longer available in HTML 5.
    • Interface Kind:
      add/remove/modify command line option, File or wire format

      Description

      Summary

      Remove the -html4 option.

      Problem

      The world is moving to HTML 5; javadoc has supported HTML 5 since JDK 9, and warned about the use of HTML 4 since JDK 11. It is a maintenance overhead to support both versions, and there is little reason to do so.

      Solution

      Remove support for HTML 4, and with it the -html4 option.

      The html5 option will remain, but will become a no-op, since HTML 5 is the only output format used. The command-line help and man page should be updated to note the option is just retained for compatibility and is no longer necessary to be used.

      javac supports a related option:

        --doclint-format {html4,html5}
              Specify the format for documentation comments

      We should remove html4 from the set of applicable values, and update the command-line help and man page.

      Specification

      The html4 option for the standard doclet will be removed.

      The html4 value for the javac --doclet-format option will be removed.

      Attached diff of Javac and Javadoc man pages.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              tmeng Tina Meng (Inactive)
              Reporter:
              jjg Jonathan Gibbons
              Reviewed By:
              Priya Lakshmi Muthuswamy (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: