commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject commons-collections git commit: Javadoc: Add missing @param tags for generics.
Date Thu, 28 Dec 2017 20:37:22 GMT
Repository: commons-collections
Updated Branches:
  refs/heads/master 5d756cebd -> 36d33722c


Javadoc: Add missing @param tags for generics.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-collections/commit/36d33722
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/36d33722
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/36d33722

Branch: refs/heads/master
Commit: 36d33722c37417b2fba57106fee185a5e422ee47
Parents: 5d756ce
Author: Gary Gregory <ggregory@apache.org>
Authored: Thu Dec 28 13:37:20 2017 -0700
Committer: Gary Gregory <ggregory@apache.org>
Committed: Thu Dec 28 13:37:20 2017 -0700

----------------------------------------------------------------------
 src/main/java/org/apache/commons/collections4/ArrayStack.java      | 1 +
 src/main/java/org/apache/commons/collections4/ListValuedMap.java   | 2 ++
 src/main/java/org/apache/commons/collections4/MultiValuedMap.java  | 2 ++
 src/main/java/org/apache/commons/collections4/SetValuedMap.java    | 2 ++
 .../commons/collections4/multimap/AbstractListValuedMap.java       | 2 ++
 .../commons/collections4/multimap/AbstractMultiValuedMap.java      | 2 ++
 .../apache/commons/collections4/multimap/AbstractSetValuedMap.java | 2 ++
 .../commons/collections4/multimap/ArrayListValuedHashMap.java      | 2 ++
 .../apache/commons/collections4/multimap/HashSetValuedHashMap.java | 2 ++
 .../commons/collections4/multimap/TransformedMultiValuedMap.java   | 2 ++
 10 files changed, 19 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/ArrayStack.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/ArrayStack.java b/src/main/java/org/apache/commons/collections4/ArrayStack.java
index 5a6e1f4..1a8c40c 100644
--- a/src/main/java/org/apache/commons/collections4/ArrayStack.java
+++ b/src/main/java/org/apache/commons/collections4/ArrayStack.java
@@ -36,6 +36,7 @@ import java.util.EmptyStackException;
  * <b>Note:</b> From version 4.0 onwards, this class does not implement the
  * removed {@code Buffer} interface anymore.
  *
+ * @param <E> the type of elements in this list
  * @see java.util.Stack
  * @since 1.0
  * @deprecated use {@link java.util.ArrayDeque} instead (available from Java 1.6)

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/ListValuedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/ListValuedMap.java b/src/main/java/org/apache/commons/collections4/ListValuedMap.java
index f01da1f..1ebc322 100644
--- a/src/main/java/org/apache/commons/collections4/ListValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/ListValuedMap.java
@@ -27,6 +27,8 @@ import java.util.List;
  *   <li>Getting a value will return a {@link List}, holding all the values put to
that key.</li>
  * </ul>
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public interface ListValuedMap<K, V> extends MultiValuedMap<K, V> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
index 0cb3cf7..b4ce38d 100644
--- a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
@@ -42,6 +42,8 @@ import java.util.Set;
  * <code>coll</code> will be a collection containing "A", "B", "C".
  * <p>
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public interface MultiValuedMap<K, V> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/SetValuedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/SetValuedMap.java b/src/main/java/org/apache/commons/collections4/SetValuedMap.java
index 4b06103..b289e24 100644
--- a/src/main/java/org/apache/commons/collections4/SetValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/SetValuedMap.java
@@ -27,6 +27,8 @@ import java.util.Set;
  *   <li>Getting a value will return a {@link Set}, holding all the values put to that
key.</li>
  * </ul>
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public interface SetValuedMap<K, V> extends MultiValuedMap<K, V> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
b/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
index 8904f6c..248f0ad 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
@@ -32,6 +32,8 @@ import org.apache.commons.collections4.ListValuedMap;
  * Subclasses specify a Map implementation to use as the internal storage and
  * the List implementation to use as values.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public abstract class AbstractListValuedMap<K, V> extends AbstractMultiValuedMap<K,
V>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
index 4772468..13ca69b 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
@@ -51,6 +51,8 @@ import org.apache.commons.collections4.multiset.UnmodifiableMultiSet;
  * <p>
  * Subclasses specify a Map implementation to use as the internal storage.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
V> {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
b/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
index 96c3140..7785cd9 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
@@ -30,6 +30,8 @@ import org.apache.commons.collections4.SetValuedMap;
  * Subclasses specify a Map implementation to use as the internal storage and
  * the Set implementation to use as values.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public abstract class AbstractSetValuedMap<K, V> extends AbstractMultiValuedMap<K,
V>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMap.java
b/src/main/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMap.java
index 873dccf..cc9d710 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMap.java
@@ -37,6 +37,8 @@ import org.apache.commons.collections4.MultiValuedMap;
  * concurrently, you must use appropriate synchronization. This class may throw
  * exceptions when accessed by concurrent threads without synchronization.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public class ArrayListValuedHashMap<K, V> extends AbstractListValuedMap<K, V>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/multimap/HashSetValuedHashMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multimap/HashSetValuedHashMap.java
b/src/main/java/org/apache/commons/collections4/multimap/HashSetValuedHashMap.java
index b06ada8..8a0c4dc 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/HashSetValuedHashMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/HashSetValuedHashMap.java
@@ -36,6 +36,8 @@ import org.apache.commons.collections4.MultiValuedMap;
  * concurrently, you must use appropriate synchronization. This class may throw
  * exceptions when accessed by concurrent threads without synchronization.
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public class HashSetValuedHashMap<K, V> extends AbstractSetValuedMap<K, V>

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMap.java
b/src/main/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMap.java
index ed1e17a..b15a1de 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMap.java
@@ -34,6 +34,8 @@ import org.apache.commons.collections4.Transformer;
  * <p>
  * <strong>Note that TransformedMultiValuedMap is not synchronized and is not thread-safe.</strong>
  *
+ * @param <K> the type of the keys in this map
+ * @param <V> the type of the values in this map
  * @since 4.1
  */
 public class TransformedMultiValuedMap<K, V> extends AbstractMultiValuedMapDecorator<K,
V> {


Mime
View raw message