This commit is contained in:
Gary Gregory 2024-08-25 18:55:28 -04:00
parent b2cea54a2c
commit c61faccf9c
6 changed files with 8 additions and 7 deletions

View File

@ -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

View File

@ -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
*/

View File

@ -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
*/

View File

@ -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 {

View File

@ -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.

View File

@ -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>
*