RFR: JDK-8234682: The order of @param in the generated docs should match the method signature

Hannes Wallnöfer hannesw at openjdk.java.net
Wed Jan 12 17:09:30 UTC 2022


On Wed, 12 Jan 2022 15:32:40 GMT, Roger Riggs <rriggs at openjdk.org> wrote:

> It would be helpful if the order of the @param tags in the source was matched the declaration. Can a warning be generated if the @param tags are out of order?

I think it is worth considering. Does it have to be a warning or would an informational notice also do? For something to be reported as warning it should have a certain gravity, I'm not sure `@param` order qualifies for it.

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

PR: https://git.openjdk.java.net/jdk/pull/7046


More information about the javadoc-dev mailing list