RFR: JDK-8284994: -Xdoclint:all returns warning for records, even when documented properly

Vicente Romero vromero at openjdk.java.net
Mon Apr 25 16:45:21 UTC 2022

On Sat, 23 Apr 2022 17:03:06 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> Please review a small fix to address issues with records in DocLint when invoked from javac. Bottom line, record components or their fields should never have direct documentation comments (and so the absence of comments should not be reported as "missing") ... they should be documented with `@param` tags in the doc comment for the record itself.
> In the course of this work, it was observed that DocLint does not check for `@param` tags for type parameters on a class or interface declaration. Fixing that uncovers issues in the JDK API documentation, so that part of the fix is disabled for now, and a followup bug has been filed. [JDK-8285496](https://bugs.openjdk.java.net/browse/JDK-8285496)



Marked as reviewed by vromero (Reviewer).

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

More information about the compiler-dev mailing list