From 9c5bf7a5be105acf6ebb1f397e4dc1d6d270ce0f Mon Sep 17 00:00:00 2001
From: Gary Gregory
Date: Thu, 11 Jul 2024 18:21:21 -0400
Subject: [PATCH] Javadoc
---
src/main/java/org/apache/commons/collections4/Factory.java | 3 +--
.../commons/collections4/functors/ConstantFactory.java | 1 +
.../commons/collections4/functors/ExceptionFactory.java | 1 +
.../commons/collections4/functors/InstantiateFactory.java | 1 +
.../commons/collections4/functors/PrototypeFactory.java | 6 ++++--
.../org/apache/commons/collections4/map/MultiValueMap.java | 2 ++
6 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/Factory.java b/src/main/java/org/apache/commons/collections4/Factory.java
index 527e31c24..56fd5d5f6 100644
--- a/src/main/java/org/apache/commons/collections4/Factory.java
+++ b/src/main/java/org/apache/commons/collections4/Factory.java
@@ -30,8 +30,7 @@ import java.util.function.Supplier;
* a copy of a prototype or a new instance.
*
*
- * @param the type that the factory creates
- *
+ * @param the type of results supplied by this supplier.
* @since 2.1
* @deprecated Use {@link Supplier}.
*/
diff --git a/src/main/java/org/apache/commons/collections4/functors/ConstantFactory.java b/src/main/java/org/apache/commons/collections4/functors/ConstantFactory.java
index d9f0ecd94..5785a9798 100644
--- a/src/main/java/org/apache/commons/collections4/functors/ConstantFactory.java
+++ b/src/main/java/org/apache/commons/collections4/functors/ConstantFactory.java
@@ -28,6 +28,7 @@ import org.apache.commons.collections4.Factory;
* use the prototype factory.
*
*
+ * @param the type of results supplied by this supplier.
* @since 3.0
*/
public class ConstantFactory implements Factory, Serializable {
diff --git a/src/main/java/org/apache/commons/collections4/functors/ExceptionFactory.java b/src/main/java/org/apache/commons/collections4/functors/ExceptionFactory.java
index 04925c9a4..9b1bc4c4a 100644
--- a/src/main/java/org/apache/commons/collections4/functors/ExceptionFactory.java
+++ b/src/main/java/org/apache/commons/collections4/functors/ExceptionFactory.java
@@ -24,6 +24,7 @@ import org.apache.commons.collections4.FunctorException;
/**
* Factory implementation that always throws an exception.
*
+ * @param the type of results supplied by this supplier.
* @since 3.0
*/
public final class ExceptionFactory implements Factory, Serializable {
diff --git a/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java b/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java
index 007b8d39e..e80cdeda1 100644
--- a/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java
+++ b/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java
@@ -32,6 +32,7 @@ import org.apache.commons.collections4.FunctorException;
* for more details.
*
*
+ * @param the type of results supplied by this supplier.
* @since 3.0
*/
public class InstantiateFactory implements Factory {
diff --git a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java
index 204cef999..65ac42cae 100644
--- a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java
+++ b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java
@@ -42,9 +42,10 @@ import org.apache.commons.collections4.FunctorException;
*/
public class PrototypeFactory {
- // PrototypeCloneFactory
/**
* PrototypeCloneFactory creates objects by copying a prototype using the clone method.
+ *
+ * @param the type of results supplied by this supplier.
*/
static class PrototypeCloneFactory implements Factory {
@@ -95,9 +96,10 @@ public class PrototypeFactory {
}
}
- // PrototypeSerializationFactory
/**
* PrototypeSerializationFactory creates objects by cloning a prototype using serialization.
+ *
+ * @param the type of results supplied by this supplier.
*/
static class PrototypeSerializationFactory implements Factory {
diff --git a/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java b/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java
index b80ce92f3..a2dfa7a3e 100644
--- a/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java
@@ -73,6 +73,8 @@ public class MultiValueMap extends AbstractMapDecorator impleme
/**
* Inner class that provides a simple reflection factory.
+ *
+ * @param the type of results supplied by this supplier.
*/
private static final class ReflectionFactory> implements Factory, Serializable {