Integrated: JDK-8234682: The order of @param in the generated docs should match the method signature
Hannes Wallnöfer
hannesw at openjdk.java.net
Thu Jan 20 16:20:56 UTC 2022
On Wed, 12 Jan 2022 08:40:08 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:
> Please review a change in how documentation from `@param` tags is generated.
>
> The old code generates parameter documentation for each `@param` in the order in which the tags occur in the comment, then adds documentation from inherited `@param` tags for undocumented parameters.
>
> The new code always generates documentation in the order in which actual parameters are declared in the code, using local or inherited `@param` tags as appropriate. Any `@param` tags that do not have a matching parameter are added afterwards.
>
> Note that `@param` is not just used for parameters of executable members but also type parameters and record components. The second commit of this PR fixes a `ClassCastException` for these uses that was caused by the first commit and adds a few tests for it.
This pull request has now been integrated.
Changeset: ec8b6acf
Author: Hannes Wallnöfer <hannesw at openjdk.org>
URL: https://git.openjdk.java.net/jdk/commit/ec8b6acff39953ca60309c6f1db7ae4c93404da9
Stats: 173 lines in 4 files changed: 95 ins; 34 del; 44 mod
8234682: The order of @param in the generated docs should match the method signature
Reviewed-by: prappo
-------------
PR: https://git.openjdk.java.net/jdk/pull/7046
More information about the javadoc-dev
mailing list