Cleaning up JDK docs: progress.

Jonathan Gibbons jonathan.gibbons at
Fri Nov 2 23:32:16 UTC 2018

As many of you may be aware, there's being an ongoing campaign over the 
past few JDK releases to "clean up" the documentation for the JDK API 
and related specs, initially focusing on bad HTML, and more recently 
focusing on broken links, both internal and external.

Although the work is not yet complete, we have been making great 
progress: most documentation for most modules is mostly OK. I've posted 
some reports, broken down by module [1] and for all the docs together [2].

The reports are generated by a new tool "doccheck" that should be 
"coming soon" to the Code Tools project [3]. The intent of the tool is 
to provide easy and fast checking for various issues that have been 
found in the documentation, such as bad HTML, broken links, etc., and to 
provide easy-to-read summaries of the problems that are found.

Thanks to all who have been involved in this cleanup effort, whether it 
has been fixing issues in the docs or docs infrastructure, or reviewing 

-- Jon


More information about the jdk-dev mailing list