Fwd: Cleaning up JDK docs: progress.

Martijn Verburg martijnverburg at gmail.com
Sat Nov 3 17:47:32 UTC 2018

Hi all,

This is a great area where you can assist as a new contributor.  Head on
over to the jdk-dev mailing list and offer to tackle some of the broken
Javadoc.  If you follow the links below you can see the packages that
require the most work.


---------- Forwarded message ---------
From: Jonathan Gibbons <jonathan.gibbons at oracle.com>
Date: Fri, 2 Nov 2018 at 23:33
Subject: Cleaning up JDK docs: progress.
To: jdk-dev <jdk-dev at openjdk.java.net>

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

[1] http://cr.openjdk.java.net/~jjg/doccheck/jdk-by-module/index.html
[2] http://cr.openjdk.java.net/~jjg/doccheck/jdk-all/report.html
[3] http://openjdk.java.net/projects/code-tools/

More information about the adoption-discuss mailing list