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

[Martin Buchholz]

Thanks.

Years ago I did this same cleanup on a subset of java.base that I
maintained.
I expected occurrences of '<tt>' would need changes as well, but it appears
there aren't any in java.base (some previous effort cleaned this up, I
guess).
I wrote this emacs command to help me:

(defun tt-code ()
  (interactive)
  (query-replace-regexp "<\\(tt\\|code\\)>\\([^<>{}&@]+\\)</\\1>" "{@code
\\2}"))

On Wed, Sep 18, 2019 at 8:48 AM Julia Boes <julia.boes at oracle.com> wrote:

> 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
>
>