On Wed, 4 Mar 2026 20:06:05 GMT, Andrei Rybak <[email protected]> wrote:
> 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:
> <https://github.com/apache/santuario-xml-security-java/pull/575>. In the copy
> of this class in the OpenJDK repository, the HTML tag `<code>` was replaced
> with `{@code ...}` in commit 9adabc35b09 ("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](https://github.com/apache/santuario-xml-security-java/blob/main/src/main/java/org/apache/xml/security/signature/Manifest.java#L223-L230)
> and [branch
> 2.1.x-fixes](https://github.com/apache/santuario-xml-security-java/blob/2.1.x-fixes/src/main/java/org/apache/xml/security/signature/Manifest.java#L226-L233)
> still have `<code>`).
>
> ---------
> - [x] I confirm that I make this contribution in accordance with the [OpenJDK
> Interim AI Policy](https://openjdk.org/legal/ai).
This pull request has now been integrated.
Changeset: f1b723bf
Author: Andrei Rybak <[email protected]>
Committer: Jaikiran Pai <[email protected]>
URL:
https://git.openjdk.org/jdk/commit/f1b723bf96a0c088ec3aecfa886db32a7ca062d6
Stats: 19 lines in 11 files changed: 0 ins; 0 del; 19 mod
8388427: Fix javadoc typos related to {@code} and {@linkplain}
Fix javadoc typos related to {@code} and {@linkplain}
Swap around `@` and `{` to the correct order in usages of `{@code ...}`
documentation comments syntax.
Add missing `@` into usages of `{@link ...}` and `{@code ...}` syntax.
Fix typos in a usage of `{@linkplain ...}` syntax.
A similar typo in the javadoc of method `item` in file
src/java.xml.crypto/share/classes/com/sun/org/apache/xml/internal/security/signature/Manifest.java
is intentionally left as is, because it is code that is imported from
the Apache Santuario library. The typo has been fixed in the upstream
repository.
Reviewed-by: jpai, sspitsyn, prr
-------------
PR: https://git.openjdk.org/jdk/pull/30061
