From a2dac490ece6f6a3a8dc7091c18318826f63a5ce Mon Sep 17 00:00:00 2001
From: Gary Gregory <garydgregory@gmail.com>
Date: Mon, 24 Jun 2024 07:55:22 -0400
Subject: [PATCH] Javadoc

---
 .../collections4/bloomfilter/LayerManager.java  |  6 +++++-
 .../collections4/list/AbstractLinkedList.java   |  3 +++
 .../collections4/map/AbstractLinkedMap.java     | 17 +++++++++++++++++
 .../collections4/trie/AbstractPatriciaTrie.java |  5 ++++-
 .../map/AbstractIterableMapTest.java            |  3 +++
 .../collections4/map/AbstractMapTest.java       |  6 ++++++
 .../commons/collections4/map/IdentityMap.java   |  5 ++++-
 7 files changed, 42 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
index b1300136f6..574a92cfb0 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -49,12 +49,16 @@
  * the {@code target} filter.</li>
  * </ol>
  *
+ *
+ * @param <T> the {@link BloomFilter} type.
  * @since 4.5.0
  */
 public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor {
 
     /**
-     * Builder to create Layer Manager
+     * Builder to create Layer Manager.
+     *
+     * @param <T> the {@link BloomFilter} type.
      */
     public static class Builder<T extends BloomFilter> {
         private Predicate<LayerManager<T>> extendCheck;
diff --git a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
index 1d66a792fa..95b271c934 100644
--- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
@@ -404,6 +404,9 @@ public void remove() {
      * <p>
      * From Commons Collections 3.1, all access to the {@code value} property
      * is via the methods on this class.
+     * </p>
+     *
+     * @param <E> The node value type. 
      */
     protected static class Node<E> {
 
diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
index 0a858ca79e..4c4cd71c9e 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
@@ -70,6 +70,9 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
 
     /**
      * EntrySet iterator.
+     *
+     * @param <K> the key type.
+     * @param <V> the value type.
      */
     protected static class EntrySetIterator<K, V> extends LinkIterator<K, V> implements
             OrderedIterator<Map.Entry<K, V>>, ResettableIterator<Map.Entry<K, V>> {
@@ -91,6 +94,8 @@ public Map.Entry<K, V> previous() {
 
     /**
      * KeySet iterator.
+     *
+     * @param <K> the key type.
      */
     protected static class KeySetIterator<K> extends LinkIterator<K, Object> implements
             OrderedIterator<K>, ResettableIterator<K> {
@@ -118,6 +123,10 @@ public K previous() {
      * then you will not be able to access the protected fields.
      * The {@code entryXxx()} methods on {@code AbstractLinkedMap} exist
      * to provide the necessary access.
+     * </p>
+     *
+     * @param <K> the key type.
+     * @param <V> the value type.
      */
     protected static class LinkEntry<K, V> extends HashEntry<K, V> {
         /** The entry before this one in the order */
@@ -140,6 +149,9 @@ protected LinkEntry(final HashEntry<K, V> next, final int hashCode, final Object
 
     /**
      * Base Iterator that iterates in link order.
+     *
+     * @param <K> the key type.
+     * @param <V> the value type.
      */
     protected abstract static class LinkIterator<K, V> {
 
@@ -223,6 +235,9 @@ public String toString() {
 
     /**
      * MapIterator implementation.
+     *
+     * @param <K> the key type.
+     * @param <V> the value type.
      */
     protected static class LinkMapIterator<K, V> extends LinkIterator<K, V> implements
             OrderedMapIterator<K, V>, ResettableIterator<K> {
@@ -271,6 +286,8 @@ public V setValue(final V value) {
 
     /**
      * Values iterator.
+     *
+     * @param <V> the value type.
      */
     protected static class ValuesIterator<V> extends LinkIterator<Object, V> implements
             OrderedIterator<V>, ResettableIterator<V> {
diff --git a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
index 85af6136f0..ea3d3801ac 100644
--- a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
+++ b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
@@ -972,7 +972,10 @@ public void set(final E item) {
     }
 
     /**
-     *  A {@link org.apache.commons.collections4.Trie} is a set of {@link TrieEntry} nodes.
+     * A {@link org.apache.commons.collections4.Trie} is a set of {@link TrieEntry} nodes.
+     *
+     * @param <K> the key type.
+     * @param <V> the value type.
      */
     protected static class TrieEntry<K, V> extends BasicEntry<K, V> {
 
diff --git a/src/test/java/org/apache/commons/collections4/map/AbstractIterableMapTest.java b/src/test/java/org/apache/commons/collections4/map/AbstractIterableMapTest.java
index 68bc2e32de..78ca9b0e39 100644
--- a/src/test/java/org/apache/commons/collections4/map/AbstractIterableMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/AbstractIterableMapTest.java
@@ -30,6 +30,9 @@
 
 /**
  * Abstract test class for {@link IterableMap} methods and contracts.
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
  */
 public abstract class AbstractIterableMapTest<K, V> extends AbstractMapTest<K, V> {
 
diff --git a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
index 5a845ae775..6ecbb3ec52 100644
--- a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
@@ -120,6 +120,9 @@
  * If your {@link Map} fails one of these tests by design, you may still use this base set of cases. Simply override the test case (method) your map fails
  * and/or the methods that define the assumptions used by the test cases. For example, if your map does not allow duplicate values, override
  * {@link #isAllowDuplicateValues()} and have it return {@code false}
+ *
+ * @param <K> the key type.
+ * @param <V> the value type.
  */
 public abstract class AbstractMapTest<K, V> extends AbstractObjectTest {
 
@@ -489,6 +492,9 @@ public void verify() {
 
     /**
      * Creates a new Map Entry that is independent of the first and the map.
+     *
+     * @param <K> the key type.
+     * @param <V> the value type.
      */
     public static <K, V> Map.Entry<K, V> cloneMapEntry(final Map.Entry<K, V> entry) {
         final HashMap<K, V> map = new HashMap<>();
diff --git a/src/test/java/org/apache/commons/collections4/map/IdentityMap.java b/src/test/java/org/apache/commons/collections4/map/IdentityMap.java
index d72e1ae47f..9d67084eb1 100644
--- a/src/test/java/org/apache/commons/collections4/map/IdentityMap.java
+++ b/src/test/java/org/apache/commons/collections4/map/IdentityMap.java
@@ -47,7 +47,10 @@ public class IdentityMap<K, V>
         extends AbstractHashedMap<K, V> implements Serializable, Cloneable {
 
     /**
-     * HashEntry
+     * HashEntry.
+     *
+     * @param <K> the key type.
+     * @param <V> the value type.
      */
     protected static class IdentityEntry<K, V> extends HashEntry<K, V> {