[jdk19] RFR: JDK-8275784: Bogus warning generated for record with compact constructor

Pavel Rappo prappo at openjdk.org
Mon Jun 27 10:38:44 UTC 2022


On Fri, 24 Jun 2022 20:53:30 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> Please review a simple change to disable the check for missing `@param` tags in the case of a compact constructor for a record. In this case, there is no explicit argument list: it is inferred from the  list of record components, and so there is no need to check for `@param` tags.

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/Checker.java line 270:

> 268:     }
> 269: 
> 270:     private  boolean isCanonicalRecordConstructor(ExecutableElement ee) {

Remove extra whitespace between `private` and `boolean`.

I would expect javax.lang.model to provide this functionality. Unfortunately, I couldn't find it. On the other hand, a very similar method exists in jdk.javadoc.internal.doclets.toolkit.util.Utils. It would be nice if we could avoid any duplication.

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

PR: https://git.openjdk.org/jdk19/pull/70


More information about the javadoc-dev mailing list