Skip to content

Fix typos in comments in Javadoc syntax {@code} and {@link}#30061

Open
rybak wants to merge 4 commits intoopenjdk:masterfrom
rybak:javadoc-syntax-typos
Open

Fix typos in comments in Javadoc syntax {@code} and {@link}#30061
rybak wants to merge 4 commits intoopenjdk:masterfrom
rybak:javadoc-syntax-typos

Conversation

@rybak
Copy link
Copy Markdown
Contributor

@rybak rybak commented Mar 4, 2026

Incorrect usages of Javadoc syntax {@code} and {@link} in documentation comments in various Java classes have been fixed.

These issues were found using various git grep commands, such as:

git grep -F '{code' -- '*.java'
git grep -F '{link' -- '*.java'
git grep -F '@{' -- '*.java'

Originally, I also included a fix for the file src/java.xml.crypto/share/classes/com/sun/org/apache/xml/internal/security/signature/Manifest.java, but after I realized that it is imported from elsewhere, I opened a pull request in the upstream repository: apache/santuario-xml-security-java#575. In the copy of this class in the OpenJDK repository, the HTML tag <code> was replaced with {@code ...} in commit 9adabc3 ("8177334: Update xmldsig implementation to Apache Santuario 2.1.1", 2018-06-19), but the Apache repository doesn't have this change (both branch main and branch 2.1.x-fixes still have <code>).


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed (2 reviews required, with at least 1 Reviewer, 1 Author)

Error

 ⚠️ Pull request body is missing required line: - [x] I confirm that I make this contribution in accordance with the [OpenJDK Interim AI Policy](https://openjdk.org/legal/ai).

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/30061/head:pull/30061
$ git checkout pull/30061

Update a local copy of the PR:
$ git checkout pull/30061
$ git pull https://git.openjdk.org/jdk.git pull/30061/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 30061

View PR using the GUI difftool:
$ git pr show -t 30061

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/30061.diff

rybak added 4 commits March 4, 2026 20:03
Swap around `@` and `{` to the correct order in usages of `{@code ...}`
documentation comments syntax.
Add missing `@` into usages of `{@code ...}` syntax
Add missing `@` into usages of `{@link ...}` syntax
@bridgekeeper
Copy link
Copy Markdown

bridgekeeper Bot commented Mar 4, 2026

👋 Welcome back rybak! 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
Copy link
Copy Markdown

openjdk Bot commented Mar 4, 2026

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk openjdk Bot added security security-dev@openjdk.org serviceability serviceability-dev@openjdk.org hotspot-compiler hotspot-compiler-dev@openjdk.org client client-libs-dev@openjdk.org core-libs core-libs-dev@openjdk.org net net-dev@openjdk.org labels Mar 4, 2026
@openjdk
Copy link
Copy Markdown

openjdk Bot commented Mar 4, 2026

@rybak The following labels will be automatically applied to this pull request:

  • client
  • core-libs
  • hotspot-compiler
  • net
  • security
  • serviceability

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

@bridgekeeper
Copy link
Copy Markdown

bridgekeeper Bot commented Apr 1, 2026

@rybak This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply issue a /touch or /keepalive command to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

@rybak
Copy link
Copy Markdown
Contributor Author

rybak commented Apr 11, 2026

/keepalive

@openjdk
Copy link
Copy Markdown

openjdk Bot commented Apr 11, 2026

@rybak The pull request is being re-evaluated and the inactivity timeout has been reset.

Copy link
Copy Markdown

@franciscoarturorivera371-cyber franciscoarturorivera371-cyber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @franciscoarturorivera371-cyber, thanks for making a comment in an OpenJDK project!

All comments and discussions in the OpenJDK Community must be made available under the OpenJDK Terms of Use. If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please Use "Add GitHub user franciscoarturorivera371-cyber" for the summary.

If you are not an OpenJDK Author, Committer or Reviewer, simply check the box below to accept the OpenJDK Terms of Use for your comments.

Your comment will be automatically restored once you have accepted the OpenJDK Terms of Use.

@openjdk
Copy link
Copy Markdown

openjdk Bot commented Apr 16, 2026

The total number of required reviews for this PR has been set to 2 based on the presence of these labels: client, hotspot-compiler. This can be overridden with the /reviewers command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

client client-libs-dev@openjdk.org core-libs core-libs-dev@openjdk.org hotspot-compiler hotspot-compiler-dev@openjdk.org net net-dev@openjdk.org security security-dev@openjdk.org serviceability serviceability-dev@openjdk.org

Development

Successfully merging this pull request may close these issues.

2 participants