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

Daniel Fuchs dfuchs at openjdk.org
Tue Oct 22 14:15:40 UTC 2024


On Tue, 22 Oct 2024 13:36:43 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.

Changes to java.management, java.naming, and sctp look good to me.

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

Marked as reviewed by dfuchs (Reviewer).

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


More information about the compiler-dev mailing list