Javadoc

apache · Aug 25, 2024 · c61facc · c61facc
1 parent b2cea54
commit c61facc
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 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
@@ -21,7 +21,7 @@
 /**
  * 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
@@ -23,7 +23,7 @@
 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
@@ -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
@@ -23,7 +23,8 @@
  *
  * <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
@@ -289,7 +289,7 @@ public static <T extends BloomFilter> Builder<T> builder() {
     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
@@ -19,7 +19,7 @@
 /**
  * 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>
  *