On Fri, 18 Aug 2023 11:30:27 GMT, Pavel Rappo <[email protected]> wrote:
> Please review this bug fix for reporting on unknown javadoc tags.
>
> Aside from a somewhat irrelevant test for DocLint[^1], there are no direct
> tests for reporting on unknown javadoc tags. That reporting, as it turns out,
> is ridden with bugs. This PR fixes quite a few of those bugs and adds missing
> tests.
>
> Note, that a test for miscased tags (i.e. "{0} is an unknown tag -- same as a
> known tag except for case") is not added, as the matching mechanism is to be
> superseded by a more general one, based on a string distance function, in
> [JDK-8288660](https://bugs.openjdk.org/browse/JDK-8288660).
>
> Also note, that while javadoc emits a warning on an unknown tag, DocLint
> emits an error. I haven't changed warning to error in javadoc for (better)
> backward compatibility. This way, an unknown tag won't fail javadoc run
> (unless of course `-Werror` is specified). That said, in the future this
> decision may be revised.
>
> [^1]: test/langtools/tools/doclint/CustomTagTest.java
This pull request has now been integrated.
Changeset: aecbb1b5
Author: Pavel Rappo <[email protected]>
URL:
https://git.openjdk.org/jdk/commit/aecbb1b5c3ea4919f09ce98a6f5a58db6e630d29
Stats: 194 lines in 4 files changed: 126 ins; 18 del; 50 mod
8314448: Coordinate DocLint and JavaDoc to report on unknown tags
Reviewed-by: jjg
-------------
PR: https://git.openjdk.org/jdk/pull/15345
