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

Reviewed-by: wetmore, smarks, dfuchs, prr, alanb, mchung
This commit is contained in:
Joe Darcy 2022-04-28 18:00:34 +00:00
parent b9d1e85151
commit bba456a8db
40 changed files with 102 additions and 26 deletions

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -54,6 +54,8 @@ import jdk.internal.util.ArraysSupport;
* <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
* Java Collections Framework</a>.
*
* @param <E> the type of elements in this collection
*
* @author Josh Bloch
* @author Neal Gafter
* @see Collection

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -65,6 +65,8 @@ import java.util.function.Consumer;
* <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
* Java Collections Framework</a>.
*
* @param <E> the type of elements in this list
*
* @author Josh Bloch
* @author Neal Gafter
* @since 1.2

View file

@ -598,6 +598,9 @@ public abstract class AbstractMap<K,V> implements Map<K,V> {
* arrays of {@code SimpleEntry} instances in method
* {@code Map.entrySet().toArray}.
*
* @param <K> the type of key
* @param <V> the type of the value
*
* @since 1.6
*/
public static class SimpleEntry<K,V>
@ -741,6 +744,8 @@ public abstract class AbstractMap<K,V> implements Map<K,V> {
* {@link Map#entry Map::entry} and {@link Map.Entry#copyOf Map.Entry::copyOf}
* methods.
*
* @param <K> the type of the keys
* @param <V> the type of the value
* @since 1.6
*/
public static class SimpleImmutableEntry<K,V>

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -57,6 +57,8 @@ package java.util;
* <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
* Java Collections Framework</a>.
*
* @param <E> the type of elements in this list
*
* @author Josh Bloch
* @author Neal Gafter
* @see Collection

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1995, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1995, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -39,6 +39,9 @@ package java.util;
* <strong>NOTE: This class is obsolete. New implementations should
* implement the Map interface, rather than extending this class.</strong>
*
* @param <K> the type of keys
* @param <V> the type of mapped values
*
* @see java.util.Map
* @see java.lang.Object#equals(java.lang.Object)
* @see java.lang.Object#hashCode()

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -71,6 +71,9 @@ import jdk.internal.access.SharedSecrets;
* <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
* Java Collections Framework</a>.
*
* @param <K> the enum type of keys maintained by this map
* @param <V> the type of mapped values
*
* @author Josh Bloch
* @see EnumSet
* @since 1.5

View file

@ -72,6 +72,8 @@ import jdk.internal.access.SharedSecrets;
* <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
* Java Collections Framework</a>.
*
* @param <E> the enum type of elements maintained by this set
*
* @author Josh Bloch
* @since 1.5
* @see EnumMap

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1994, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1994, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -49,6 +49,8 @@ package java.util;
* adapt an {@code Enumeration} to an {@code Iterator} by using the
* {@link #asIterator} method.
*
* @param <E> the type of elements returned by this enumeration
*
* @see java.util.Iterator
* @see java.io.SequenceInputStream
* @see java.util.Enumeration#nextElement()

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -48,6 +48,8 @@ package java.util;
* If the calling method is interested in retrieving the named property
* then it would have to test the element to see if it is a proxy class.
*
* @param <T> the type of {@code EventListener} being wrapped
*
* @since 1.4
*/
public abstract class EventListenerProxy<T extends EventListener>

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -130,6 +130,9 @@ import jdk.internal.access.SharedSecrets;
* and operation mixes, this class will yield better performance than
* {@link HashMap}, which uses <i>chaining</i> rather than linear-probing.
*
* @param <K> the type of keys maintained by this map
* @param <V> the type of mapped values
*
* @see System#identityHashCode(Object)
* @see Object#hashCode()
* @see Collection

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -49,6 +49,8 @@ package java.util;
* <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
* Java Collections Framework</a>.
*
* @param <E> the type of elements returned by this list iterator
*
* @author Josh Bloch
* @see Collection
* @see List

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -421,6 +421,9 @@ public interface Map<K, V> {
* var entries = map.entrySet().stream().map(Map.Entry::copyOf).toList()
* }</pre>
*
* @param <K> the type of the key
* @param <V> the type of the value
*
* @see Map#entrySet()
* @since 1.2
*/

View file

@ -1358,6 +1358,8 @@ public final class Spliterators {
* extending this class, such as when there is already an iterator
* available to use.
*
* @param <T> the type of elements returned by this Spliterator
*
* @see #spliterator(Iterator, long, int)
* @since 1.8
*/

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1994, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -42,6 +42,8 @@ package java.util;
* <pre> {@code
* Deque<Integer> stack = new ArrayDeque<Integer>();}</pre>
*
* @param <E> Type of component elements
*
* @author Jonathan Payne
* @since 1.0
*/

View file

@ -58,6 +58,8 @@ package java.util.concurrent;
* actions taken by that task, which in turn <i>happen-before</i>
* actions following a successful return from the corresponding {@code take()}.
*
* @param <V> the type of values the tasks of this service produce and consume
*
* @since 1.5
*/
public interface CompletionService<V> {

View file

@ -145,6 +145,8 @@ import java.util.function.Function;
* enables interoperability among different implementations of this
* interface by providing a common conversion type.
*
* @param <T> the type of values the stage produces or consumes
*
* @author Doug Lea
* @since 1.8
*/

View file

@ -4587,6 +4587,9 @@ public class ConcurrentHashMap<K,V> extends AbstractMap<K,V>
* {@link #newKeySet() newKeySet()},
* {@link #newKeySet(int) newKeySet(int)}.
*
* @param <K> the type of keys
* @param <V> the type of values in the backing map
*
* @since 1.8
*/
public static final class KeySetView<K,V> extends CollectionView<K,V,K>

View file

@ -420,6 +420,8 @@ import java.lang.invoke.VarHandle;
* new HeaderBuilder(p, ...).fork();
* new BodyBuilder(p, ...).fork();}</pre>
*
* @param <T> the type of the result of the completer
*
* @since 1.8
* @author Doug Lea
*/

View file

@ -98,6 +98,8 @@ package java.util.concurrent;
* use(result);
* }}</pre>
*
* @param <V> the type of values the tasks of this service produce and consume
*
* @since 1.5
*/
public class ExecutorCompletionService<V> implements CompletionService<V> {

View file

@ -198,6 +198,8 @@ import java.util.concurrent.locks.LockSupport;
* sensible to serialize tasks only before or after, but not during,
* execution. Serialization is not relied on during execution itself.
*
* @param <V> the type of the result of the task
*
* @since 1.7
* @author Doug Lea
*/

View file

@ -62,6 +62,8 @@ package java.util.concurrent;
* minimum granularity size (for example 10 here) for which you always
* sequentially solve rather than subdividing.
*
* @param <V> the type of the result of the task
*
* @since 1.7
* @author Doug Lea
*/

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -99,6 +99,8 @@ import jdk.internal.util.random.RandomSupport.RandomGeneratorProperties;
* System.out.println(rng.nextLong());
* }
*
* @param <T> type of created random generator
*
* @since 17
*
* @see java.util.random