Integrated: 8342827: Fix order of @param tags in other modules
Hannes Wallnöfer
hannesw at openjdk.org
Fri Oct 25 07:11:19 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.
This pull request has now been integrated.
Changeset: fd5ff054
Author: Hannes Wallnöfer <hannesw at openjdk.org>
URL: https://git.openjdk.org/jdk/commit/fd5ff0547ced6733ae05f1428664062615408dc9
Stats: 144 lines in 28 files changed: 58 ins; 58 del; 28 mod
8342827: Fix order of @param tags in other modules
Reviewed-by: jpai, iris, joehw, darcy, dfuchs
-------------
PR: https://git.openjdk.org/jdk/pull/21637
More information about the compiler-dev
mailing list