RFR: 8279931: Generate warning for wrong @param tag order

Hannes Wallnöfer hannesw at openjdk.org
Fri Oct 25 12:38:13 UTC 2024


Please review a change to add a DocLint warning for JavaDoc `@param` tags that don't match the order of parameters in the documented element. The warning is part of the the DocLint "reference" group. 

The code to check order of `@param` tags is written to detect wrong order even if some tags are missing. The test therefore contains a case combining missing and unordered tags, and runs `javadoc` both with reference warnings enabled and disabled.

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

Commit messages:
 - Fix whitespace
 - 8279931: Generate warning for wrong @param tag order

Changes: https://git.openjdk.org/jdk/pull/21711/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=21711&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8279931
  Stats: 110 lines in 3 files changed: 95 ins; 0 del; 15 mod
  Patch: https://git.openjdk.org/jdk/pull/21711.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/21711/head:pull/21711

PR: https://git.openjdk.org/jdk/pull/21711


More information about the javadoc-dev mailing list