8067127: Tags cleanup

[bplb]

Please review this change to update some javadoc tags in the java.io package. The changes are to replace some occurrences of some_code with {@code some_code}. Not all such constructs were replaced as being infeasible, e.g., tag contains an entity such as */ (DataOutput, Serial), or multiple {@code} tags would be needed or the result would be ugly (File). It is unclear whether some of the changes which remove the non-breaking space entity ( ) are desirable.

Thanks,

Brian

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed

Testing

	Linux x64	Windows x64	macOS x64
Build	✔️ (3/3 passed)	✔️ (2/2 passed)	✔️ (2/2 passed)
Test (tier1)	✔️ (9/9 passed)	❌ (1/9 failed)	✔️ (9/9 passed)

Failed test task

• Windows x64 (langtools/tier1)

Issue

• JDK-8067127: Tags cleanup

Reviewers

• Roger Riggs (@RogerRiggs - Reviewer) ⚠️ Review applies to 2e9b077
• Daniel Fuchs (@dfuch - Reviewer)
• Lance Andersen (@LanceAndersen - Reviewer)

Download

$ git fetch https://git.openjdk.java.net/jdk pull/513/head:pull/513
$ git checkout pull/513

[bridgekeeper]

👋 Welcome back bpb! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@bplb The following label will be automatically applied to this pull request:

• core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 01: Full - Incremental (3cbb98d)
• 00: Full (2e9b077)

[pavelrappo]

From the perspective of the Standard Doclet this change looks good. I have to note, however, that there are minor losses in markup, e.g. unused italic highlighting such as <i>c</i>. On that I don't have an opinion.

[bplb]

Thanks. I didn't think that the loss of italics was significant where this change was applied.

[openjdk]

@bplb This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8067127: Tags cleanup

Reviewed-by: rriggs, dfuchs, lancea

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 28 new commits pushed to the master branch:

• 04ca660: 8253874: [JVMCI] added test omitted in 8252881
• 49128a1: 8253475: Javadoc clean up in HttpExchange and HttpServer
• 9543d76: 8253000: Remove redundant MAKE_SUBDIR argument
• 4dfa411: 8252997: Null-proofing for linker_md.c
• 97ff38c: 8254141: Typo in copyright year
• cd4faff: 8249095: tools/javac/launcher/SourceLauncherTest.java fails on Windows
• bdd5782: 8253980: javax/swing/plaf/synth/7158712/bug7158712.java fails on windows
• 703b345: 8253179: Replace LinkedList Impl in net.http.Http2Connection
• 3973073: 8253977: More memory leaks in client-libs on macOS
• 2a0389a: 8254095: remove jdk.test.lib.Utils::distro() method
• ... and 18 more: https://git.openjdk.java.net/jdk/compare/f2f77f7b1487e5080641fd4c72766ac774c21f98...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[openjdk]

⚠️ @bplb This pull request contains merges that bring in commits not present in the target repository. Since this is not a "merge style" pull request, these changes will be squashed when this pull request in integrated. If this is your intention, then please ignore this message. If you want to preserve the commit structure, you must change the title of this pull request to Merge <project>:<branch> where <project> is the name of another project in the OpenJDK organization (for example Merge jdk:master).

[dfuch]

New changes LGTM!

best regards,

-- daniel

[bplb]

/integrate

[openjdk]

@bplb Since your change was applied there have been 31 commits pushed to the master branch:

• 739347f: 8254168: Remove TemplateTable::count_calls
• 4fe07cc: 8252324: Signal related code should be shared among POSIX platforms
• 1e8e543: 8216497: javadoc should auto-link to platform classes
• 04ca660: 8253874: [JVMCI] added test omitted in 8252881
• 49128a1: 8253475: Javadoc clean up in HttpExchange and HttpServer
• 9543d76: 8253000: Remove redundant MAKE_SUBDIR argument
• 4dfa411: 8252997: Null-proofing for linker_md.c
• 97ff38c: 8254141: Typo in copyright year
• cd4faff: 8249095: tools/javac/launcher/SourceLauncherTest.java fails on Windows
• bdd5782: 8253980: javax/swing/plaf/synth/7158712/bug7158712.java fails on windows
• ... and 21 more: https://git.openjdk.java.net/jdk/compare/f2f77f7b1487e5080641fd4c72766ac774c21f98...master

Your commit was automatically rebased without conflicts.

Pushed as commit db3053d.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.