From c61faccf9c81ff36f0d037b954ff620c97b0f8a5 Mon Sep 17 00:00:00 2001
From: Gary Gregory <garydgregory@gmail.com>
Date: Sun, 25 Aug 2024 18:55:28 -0400
Subject: [PATCH] Javadoc

---
 .../apache/commons/collections4/bloomfilter/BloomFilter.java  | 2 +-
 .../collections4/bloomfilter/BloomFilterExtractor.java        | 2 +-
 .../org/apache/commons/collections4/bloomfilter/Hasher.java   | 4 ++--
 .../apache/commons/collections4/bloomfilter/IndexFilter.java  | 3 ++-
 .../apache/commons/collections4/bloomfilter/LayerManager.java | 2 +-
 .../org/apache/commons/collections4/bloomfilter/Shape.java    | 2 +-
 6 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
index 3a6fe7199..0a6e1b38e 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
@@ -21,7 +21,7 @@ import java.util.Objects;
 /**
  * The interface that describes a Bloom filter.
  * <p>
- * <em>See implementation notes for BitMapExtractor and IndexExtractor.</em>
+ * <em>See implementation notes for {@link BitMapExtractor} and {@link IndexExtractor}.</em>
  * </p>
  * @see BitMapExtractor
  * @see IndexExtractor
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java
index 95dbc6800..e5f5a6aa7 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java
@@ -23,7 +23,7 @@ import java.util.function.BiPredicate;
 import java.util.function.Predicate;
 
 /**
- * Produces Bloom filters from a collection (e.g. LayeredBloomFilter).
+ * Produces Bloom filters from a collection (for example, {@link LayeredBloomFilter}).
  *
  * @since 4.5.0
  */
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java b/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java
index 4de30d0d6..ce4b9c227 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java
@@ -17,8 +17,8 @@
 package org.apache.commons.collections4.bloomfilter;
 
 /**
- * A Hasher creates IndexExtractor based on the hash implementation and the
- * provided Shape.
+ * A Hasher creates {@link IndexExtractor}s based on the hash implementation and the
+ * provided {@link Shape}.
  *
  * @since 4.5.0
  */
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
index a6c7c5b0d..300831b2c 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
@@ -23,7 +23,8 @@ import java.util.function.IntPredicate;
  *
  * <p><em>If the index is negative the behavior is not defined.</em></p>
  *
- * <p>This is conceptually a unique filter implemented as an {@code IntPredicate}.</p>
+ * <p>This is conceptually a unique filter implemented as an {@link IntPredicate}.</p>
+ *
  * @since 4.5.0
  */
 public final class IndexFilter {
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 2755a0ba0..5e18f99ba 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -289,7 +289,7 @@ public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor
     private final Supplier<T> filterSupplier;
 
     /**
-     * Constructor.
+     * Constructs a new instance.
      *
      * @param filterSupplier the supplier of new Bloom filters to add the the list
      *                       when necessary.
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java b/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java
index d490ba0e1..1411dee37 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java
@@ -19,7 +19,7 @@ package org.apache.commons.collections4.bloomfilter;
 /**
  * The definition of a Bloom filter shape.
  *
- * <p> This class contains the values for the filter configuration and is used to
+ * <p>This class contains the values for the filter configuration and is used to
  * convert a Hasher into a BloomFilter as well as verify that two Bloom filters are
  * compatible. (i.e. can be compared or merged)</p>
  *