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

Alan Bateman alanb at openjdk.java.net
Thu Apr 28 08:14:25 UTC 2022


On Thu, 28 Apr 2022 01:34:19 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.
>
> Joe Darcy has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Respond to more review feedback.

src/java.base/share/classes/java/nio/file/SecureDirectoryStream.java line 55:

> 53:  * against the <i>original path</i> of the directory (irrespective of if the
> 54:  * directory is moved since it was opened).
> 55:  * @param <T> the type of path

It may not be a path. The type parameter is specified in the super interfaces, can you copy that down instead?

src/java.base/share/classes/java/nio/file/WatchEvent.java line 51:

> 49:     /**
> 50:      * An event kind, for the purposes of identification.
> 51:      * @param <T> the type of the context value

This is okay but the it differs slightly to the type parameters specified further up. I think the issue here is that it was just wasn't copied down to WatchEvent.Kind.

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

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



More information about the client-libs-dev mailing list