RFR: 8179364: update "<a name=" in java.base module to use id attribute
Jonathan Gibbons
jonathan.gibbons at oracle.com
Wed Apr 26 20:30:28 UTC 2017
Please review the following conceptually simple fix to change
<a name=
to
<a id=
in the public doc comments for the contents of java.base module.
This is for compatibility with HTML 5.
The change was done mechanically with the following two commands:
$ sed -i -e 's/<a name=/<a id=/g' $files
$ sed -i -e 's/<A NAME=/<a id=/' $files
where $files was derived from the set of files reported by "javadoc
-html5" as containing the use of the name attribute.
The covers files in the following packages:
java.base java/io
java.base java/lang
java.base java/lang/invoke
java.base java/lang/ref
java.base java/lang/reflect
java.base java/net
java.base java/nio
java.base java/nio/channels
java.base java/nio/charset
java.base java/nio/file
java.base java/text
java.base java/util
java.base java/util/jar
java.base java/util/regex
java.base java/util/spi
java.base java/util/stream
Notes:
1. There may be instances of the name attribute remaining in other
comments that have not been updated.
2. There are many instances where the id attribute could be moved into
an immediate neighbor. For simplicity, that has not been done at this
time. It would be a worthy update when we have fully committed to
delivering HTML 5 docs, and have the resources to do a more hands-on update.
JBS: https://bugs.openjdk.java.net/browse/JDK-8179364
Webrev: http://cr.openjdk.java.net/~jjg/8179364/webrev.00/
-- Jon
More information about the core-libs-dev
mailing list