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

[Joe Darcy]

On Wed, 27 Apr 2022 01:39:27 GMT, Stuart Marks <smarks 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.
>
> src/java.base/share/classes/java/util/AbstractMap.java line 601:
> 
>> 599:      * {@code Map.entrySet().toArray}.
>> 600:      *
>> 601:      * @param <K> the type of keys maintained
> 
> Please update to match java.util.Map, which says "the type of keys maintained by this map"

I said "keys maintained", omitting "by this map" to finesse the question of if the SimpleEntry class *is* a map, or is used to implement a map, etc. I can change it to include "by this map" if the map/entry distinction is okay to be blurred.

> src/java.base/share/classes/java/util/Dictionary.java line 44:
> 
>> 42:  * @param <K> the type of keys
>> 43:  * @param <V> the type of mapped values
>> 44:  *
> 
> Urgh. This class is obsolete, but it was retrofitted to implement Map and was subsequently generified, so I'd update these to match java.util.Map.

The javadoc of Dictionary states "The Dictionary class [...] maps keys to values." which was my guide for the wording, but I don't mind changing it.

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

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