RFR: 8342825: Fix order of @param tags in module java.desktop
Phil Race
prr at openjdk.org
Tue Oct 22 20:55:04 UTC 2024
On Tue, 22 Oct 2024 13:12:38 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:
> Please review a doc-only change to fix the order of javadoc @param tags in module java.desktop.
>
> 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.
ALL LGTM. I'm pleasantly surprised there are relatively few such cases.
-------------
Marked as reviewed by prr (Reviewer).
PR Review: https://git.openjdk.org/jdk/pull/21636#pullrequestreview-2386284994
More information about the client-libs-dev
mailing list