RFR: JDK-8285676: Add missing @param tags for type parameters on classes and interfaces

Daniel Fuchs dfuchs at openjdk.java.net
Wed Apr 27 10:59:43 UTC 2022


On Tue, 26 Apr 2022 22:24:26 GMT, Joe Darcy <darcy at openjdk.org> wrote:

> To enable more complete doclint checking (courtesy @jonathan-gibbons), please review this PR to add type-level @param tags where they are missing.
> 
> To the maintainers of java.util.concurrent, those changes could be separated out in another bug if that would ease maintenance of that code.
> 
> Making these library fixes is a blocker for correcting and expanding the doclint checks (JDK-8285496).
> 
> I'll update copyright years before pushing.

Hi Joe, just two suggestions about the javax.management changes. Otherwise looks good!

src/java.management/share/classes/javax/management/openmbean/ArrayType.java line 96:

> 94:  *
> 95:  * @param <T> the Java type that instances described by this type must
> 96:  * have.

Instead of "instances" - would it be more correct to say "array elements"?

src/java.management/share/classes/javax/management/openmbean/SimpleType.java line 60:

> 58:  * @param <T> the Java type that instances described by this type must
> 59:  * have.
> 60:  *

I would suggest to say "that values described by this type"...

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

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


More information about the security-dev mailing list