JEP 224: HTML5 JavadocJEP 224: HTML5 JavadocOwnerBhavesh PatelTypeFeatureScopeJDKStatusClosed / DeliveredRelease9Componenttools / javadoc(tool)Discussionjavadoc dash dev at openjdk dot java dot netEffortMDurationMReviewed byJonathan GibbonsEndorsed byBrian GoetzCreated2014/06/05 20:00Updated2018/04/13 08:16Issue8046068Summary
Enhance the javadoc tool to generate HTML5 markup.
Goals
Provide an option to the standard doclet to request either HTML 4 or HTML5 output.
The HTML5 markup is semantic, i.e., clearly separating meaning from
style and content. The parts of the pages generated by the standard doclet
using HTML5 markup satisfy accessibility requirements.
Non-Goals
It is a not a goal to replace the current three-frame/no-frame structure of the
generated HTML pages; that may be the subject of a future JEP.
It is not a goal to mandate the use of HTML5 in documentation comments,
nor is it a goal to provide the ability to convert documentation comments written using
HTML 4 to HTML5.
Motivation
In JDK 8 and older releases, the standard doclet generated pages in HTML 4.01,
which is an old standard, and not not provide support for satisfying accessibility requirements.
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 the standard doclet to request a
specific type of output markup.  HTML4, which is the current type,
will be the default.  HTML5 will become the default in JDK 10.


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 update to check documentation comments
for common errors, based upon the requested type of output markup.


Testing
Tests are provided 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. A representative sample
of different types of pages can checked using online web-based
tools.
InstallingContributingSponsoringDevelopers' GuideVulnerabilitiesJDK GA/EA BuildsMailing listsWiki
                      · IRCBylaws · CensusLegalWorkshopJEP ProcessSource codeMercurialGitHubToolsGitjtreg harnessGroups(overview)AdoptionBuildClient LibrariesCompatibility & Specification ReviewCompilerConformanceCore LibrariesGoverning BoardHotSpotIDE Tooling & SupportInternationalizationJMXMembersNetworkingPortersQualitySecurityServiceabilityVulnerabilityWebProjects(overview,
      archive)AmberBabylonCRaCCaciocavalloClosuresCode ToolsCoinCommon VM InterfaceCompiler GrammarDetroitDevelopers' GuideDevice I/ODukeGalahadGraalIcedTeaJDK 7JDK 8JDK 8 UpdatesJDK 9JDK
      (…,
       21,
       22,
       23)JDK UpdatesJavaDoc.NextJigsawKonaKullaLambdaLanaiLeydenLilliputLocale EnhancementLoomMemory Model UpdateMetropolisMission ControlMulti-Language VMNashornNew I/OOpenJFXPanamaPenrosePort: AArch32Port: AArch64Port: BSDPort: HaikuPort: Mac OS XPort: MIPSPort: MobilePort: PowerPC/AIXPort: RISC-VPort: s390xPortolaSCTPShenandoahSkaraSumatraTiered AttributionTsanType AnnotationsValhallaVeronaVisualVMWakefieldZeroZGC

        © 2024 Oracle Corporation and/or its affiliates
        Terms of Use
        ·
        
            License: GPLv2
        · Privacy
        · Trademarks
