JEP 224: HTML5 Javadoc

OwnerBhavesh Patel
Created2014/06/05 20:00
Updated2017/05/22 17:44
TypeFeature
StatusCompleted
Componenttools / javadoc(tool)
ScopeJDK
Discussionjavadoc dash dev at openjdk dot java dot net
EffortM
DurationM
Priority2
Reviewed byJonathan Gibbons
Endorsed byBrian Goetz
Release9
Issue8046068

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

Testing

Tests are implemented/performed to ensure that:

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