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

Hello Andrei, for PRs to be officially reviewed, they require a corresponding 
JBS issue to be filed. The usual process to do that is described in the OpenJDK 
developers guide 
https://openjdk.org/guide/#i-found-an-issue-in-jbs-that-i-want-to-fix.

For this specific one, I went ahead and created an issue for you 
https://bugs.openjdk.org/browse/JDK-8388427. Please update the title of this PR 
to `8388427: Fix javadoc typos related to {@code} and {@linkplain}` so that the 
review process gets initiated.

-------------

PR Comment: https://git.openjdk.org/jdk/pull/30061#issuecomment-5000424761

Reply via email to