From ac05d8fdbe62bbfe051e3b502e5f0fcfbba56c9b Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Mon, 13 Nov 2023 07:27:16 -0500 Subject: [PATCH] Fix Javadoc code elements --- .../bloomfilter/ArrayCountingBloomFilter.java | 2 +- .../bloomfilter/CountingLongPredicate.java | 14 +++++++------- .../commons/collections4/bloomfilter/Hasher.java | 2 +- .../collection/AbstractCollectionTest.java | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java index b06f2c4d4c..188d899ae7 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java @@ -62,7 +62,7 @@ public final class ArrayCountingBloomFilter implements CountingBloomFilter { private final int[] cells; /** - * The state flag. This is a bitwise @{code OR} of the entire history of all updated + * The state flag. This is a bitwise {@code OR} of the entire history of all updated * cells. If negative then a negative cell or integer overflow has occurred on * one or more cells in the history of the filter and the state is invalid. * diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingLongPredicate.java b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingLongPredicate.java index 83d4c1a8cb..1f638d4b11 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingLongPredicate.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingLongPredicate.java @@ -19,10 +19,10 @@ import java.util.function.LongPredicate; /** - * A long predicate that applies the test func to each member of the @{code ary} in sequence for each call to @{code test()}. - * if the @{code ary} is exhausted, the subsequent calls to @{code test} are executed with a zero value. - * If the calls to @{code test} do not exhaust the @{code ary} the @{code forEachRemaining} method can be called to - * execute the @code{text} with a zero value for each remaining @{code idx} value. + * A long predicate that applies the test func to each member of the {@code ary} in sequence for each call to {@code test()}. + * if the {@code ary} is exhausted, the subsequent calls to {@code test} are executed with a zero value. + * If the calls to {@code test} do not exhaust the {@code ary} the {@code forEachRemaining} method can be called to + * execute the @code{text} with a zero value for each remaining {@code idx} value. */ class CountingLongPredicate implements LongPredicate { private int idx; @@ -30,9 +30,9 @@ class CountingLongPredicate implements LongPredicate { private final LongBiPredicate func; /** - * Constructs an instance that will compare the elements in @{code ary} with the elements returned by @{code func}. - * function is called as @{code func.test( idxValue, otherValue )}. If there are more @{code otherValue} values than - * @{code idxValues} then @{code func} is called as @{code func.test( 0, otherValue )}. + * Constructs an instance that will compare the elements in {@code ary} with the elements returned by {@code func}. + * function is called as {@code func.test( idxValue, otherValue )}. If there are more {@code otherValue} values than + * {@code idxValues} then {@code func} is called as {@code func.test( 0, otherValue )}. * @param ary The array of long values to compare. * @param func The function to apply to the pairs of long values. */ 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 5b1b6a127b..e2c30d5d28 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java @@ -27,7 +27,7 @@ public interface Hasher { /** * Creates an IndexProducer for this hasher based on the Shape. * - *

The @{code IndexProducer} will create indices within the range defined by the number of bits in + *

The {@code IndexProducer} will create indices within the range defined by the number of bits in * the shape. The total number of indices will respect the number of hash functions per item * defined by the shape. However the count of indices may not be a multiple of the number of * hash functions if the implementation has removed duplicates.

diff --git a/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java b/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java index 1191c32262..39786659ec 100644 --- a/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java +++ b/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java @@ -53,7 +53,7 @@ *

* You should create a concrete subclass of this class to test any custom * {@link Collection} implementation. At minimum, you'll have to - * implement the @{@link #makeObject()}, {@link #makeConfirmedCollection()} + * implement the {@link #makeObject()}, {@link #makeConfirmedCollection()} * and {@link #makeConfirmedFullCollection()} methods. * You might want to override some of the additional public methods as well: *