On Sun, 19 Jul 2026 23:51:20 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).
>
> Andrei Rybak has updated the pull request with a new target base due to a 
> merge or a rebase. The incremental webrev excludes the unrelated changes 
> brought in by the merge/rebase. The pull request contains six additional 
> commits since the last revision:
> 
>  - copyright year update
>    
>    per comment from jaikiran: 
> https://github.com/openjdk/jdk/pull/30061#issuecomment-5009342772
>  - Merge branch 'master' into javadoc-syntax-typos
>  - Fix Javadocs syntax {@linkplain ...}
>  - Fix Javadoc syntax {link ...} -> {@link ...}
>    
>    Add missing `@` into usages of `{@link ...}` syntax
>  - Fix Javadoc syntax {code ...} -> {@code ...}
>    
>    Add missing `@` into usages of `{@code ...}` syntax
>  - Fix Javadoc syntax @{code ...} -> {@code ...}
>    
>    Swap around `@` and `{` to the correct order in usages of `{@code ...}`
>    documentation comments syntax.

Thank you for the update. This looks good and trivial to me.

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

Marked as reviewed by jpai (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/30061#pullrequestreview-4731792162

Reply via email to