RFR: 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base

Julia Boes julia.boes at oracle.com
Wed Sep 18 15:47:57 UTC 2019


Hi,

This change replaces the HTML code tag with the equivalent javadoc tag 
in the java.base module as such:

<code>foo</code> becomes {@code foo}

Ignored are any code tags that enclose other HTML or javadoc tags or 
that contain HTML entities, e.g. character codes.


Examples (after change):

java.base/share/classes/java/nio/charset/spi/CharsetProvider.java

51 * ignored.  The comment character is {@code '#'} 
(<code>'\u0023'</code>); on

java.base/share/classes/java/io/File.java

625 * <code>new File(this.{@link #getCanonicalPath})</code>.


I reviewed the change with specdiff and doccheck on the java.base 
module, neither flagged any differences or errors. I also reviewed the 
javadoc of some classes manually but did not do an extensive manual review.

Bug: https://bugs.openjdk.java.net/browse/JDK-8231186

Webrev: http://cr.openjdk.java.net/~jboes/webrevs/8231186/webrev.02/


The copyright year will be updated before generating the changeset.

Regards,

Julia



More information about the core-libs-dev mailing list