Details

    • JEP Type:
      Feature
    • Exposure:
      Open
    • Subcomponent:
    • Scope:
      JDK
    • Discussion:
      javadoc dash dev at openjdk dot java dot net
    • Effort:
      M
    • Duration:
      M
    • Alert Status:
       Green
    • JEP Number:
      224

      Description

      Summary

      Enhanced the javadoc tool to generate HTML5 markup.

      Goals

      Provided an option to javadoc requesting either HTML 4 or HTML5 output. The HTML5 markup is semantic, i.e., clearly separate meaning from style and content. The pages generated using HTML5 markup satisfies accessibility requirements.

      Non-Goals

      It is a not a goal to replace the current three-frame structure of the generated HTML pages; that may be the subject of a future JEP.

      Motivation

      The javadoc tool generated pages in HTML 4.01, which is an old standard. HTML5 is the latest standard for HTML. HTML5 increases the semantic value of web pages and makes it easier to create accessible web pages.

      Description

      • A command-line option is added to javadoc to request a specific type of output markup. HTML4, which is the current output, will be the default. HTML5 will become the default in a later JDK release.

      • The semantic value of the generated HTML is improved by using structural HTML5 elements such as header, footer, nav, etc.

      • The HTML5 markup implements the WAI-ARIA standard for accessibility. Specific roles are assigned to elements in the HTML document using the role attribute.

      • The -Xdoclint feature is modified to validate input comments based upon the requested markup.

      Testing

      Tests are implemented/performed to ensure that:

      • The HTML5 markup is valid
      • The HTML5 markup is accessible
      • The new command-line option works correctly
      • The HTML5 markup works across all supported browsers

      The lack of automated tools to test accessibility hampers comprehensive accessibility testing.

        Issue Links

          Activity

          There are no comments yet on this issue.

            People

            • Assignee:
              bpatel Bhavesh Patel
              Reporter:
              bpatel Bhavesh Patel
              Owner:
              Bhavesh Patel
              Reviewed By:
              Jonathan Gibbons
              Endorsed By:
              Brian Goetz
            • Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

              • Due:
                Created:
                Updated:
                Integration Due: