RFR (JDK11/doc-only) 8199176: Accessibility issues in java.base docs

Joe Wang huizhe.wang at oracle.com
Wed Mar 21 19:08:41 UTC 2018


Please an accessibility fix for several package-info files.

The report contained 4 items. Among them, 1 and 2 are issues in the 
javadoc tool, and 3 could use an improvement in the tool or 
documentation. For reference, please see the linked issues in JBS [1].

For the current issue, we're fixing item 3 manually. Item 4 is a 
separate issue, but it's bundled with this fix to cut the overhead.

*Item 3*: Heading leavels should only increase by one
     This is due to the javadoc tool generates a header with an addition 
of headings, in this particular case, <h1>. The fix for this particular 
case is to replace the <h3>s with <h2>.

    Since I know the java.xml packages suffer the same issue, I've 
included them in this fix as well. For other modules, I'll leave it to 
the accessibility team.

    The fix is verified using the accessibility tool, the issue "Heading 
leavels should only increase by one" no longer showed for the new API doc.

*Item 4*: Broken inner link
     There were 4: 3 of them missed the "#" sign (as in "FEATURE", 
"INTERIM", "UPDATE"), the last one was due to capitalization, the inner 
linked was mistyped in lower case "#feature" when it should have been 

     You may search the source with

                <a id="

     to find the anchor, e.g. line 874 :

                <a id="FEATURE">

JBS: https://bugs.openjdk.java.net/browse/JDK-8199176
webrev: http://cr.openjdk.java.net/~joehw/jdk11/8199176/webrev/

[1] https://bugs.openjdk.java.net/browse/JDK-8199176


More information about the core-libs-dev mailing list