RFR: 8342827: Fix order of @param tags in other modules
Hannes Wallnöfer
hannesw at openjdk.org
Tue Oct 22 13:41:27 UTC 2024
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.
-------------
Commit messages:
- 8342827: Fix order of @param tags in other modules
Changes: https://git.openjdk.org/jdk/pull/21637/files
Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=21637&range=00
Issue: https://bugs.openjdk.org/browse/JDK-8342827
Stats: 144 lines in 28 files changed: 58 ins; 58 del; 28 mod
Patch: https://git.openjdk.org/jdk/pull/21637.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/21637/head:pull/21637
PR: https://git.openjdk.org/jdk/pull/21637
More information about the compiler-dev
mailing list