RFR: 8342827: Fix order of @param tags in other modules [v2]

Jaikiran Pai jpai at openjdk.org
Thu Oct 24 12:44:05 UTC 2024


On Thu, 24 Oct 2024 12:17:41 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> Please review a doc-only change to fix the order of javadoc @param tags in in various OpenJDK modules. This is the third and last PR to fix the order of @param tags in OpenJDK libraries.
>> 
>> We are working on a javadoc feature to add an opt-in doclint warning for @param tags that don't match the order of parameters in the documented element. The warning will be enabled in OpenJDK builds and covers all uses of the @param tag, i.e. parameters of executable elements, type parameters, and record components.
>> 
>> I compared the generated API docs built with this branch with API docs built from master branch to make sure they are identical.
>
> Hannes Wallnöfer has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Fix copyright header

This doc-only change which merely reorders the `@param` tags looks OK to me.

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

Marked as reviewed by jpai (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/21637#pullrequestreview-2392367946


More information about the compiler-dev mailing list