fixed javadoc issues

apache · Jun 30, 2023 · 62eba66 · 62eba66
1 parent 1a647d5
commit 62eba66
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterProducer.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterProducer.java
@@ -74,8 +74,7 @@ BloomFilter[] toArray() {
      * Applies the {@code func} to each Bloom filter pair in order. Will apply all
      * of the Bloom filters from the other BloomFilterProducer to this producer. If
      * this producer does not have as many BloomFilters it will provide
-     *
-     * @{code null} for all excess calls to the BiPredicate.
+     * {@code null} for all excess calls to the BiPredicate.
      *
      * @param other The other BloomFilterProducer that provides the y values in the
      *              (x,y) pair.

diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -76,6 +76,9 @@ private ExtendCheck() {
          * Calculates the estimated number of Bloom filters (n) that have been merged
          * into the target and compares that with the estimated maximum expected n based
          * on the shape. If the target is full then a new target is created.
+         * 
+         * @param shape The shape of the filters in the LayerManager.
+         * @return A Predicate suitable for the LayerManager extendCheck parameter.
          */
         public static final Predicate<LayerManager> advanceOnCalculatedFull(Shape shape) {
             return advanceOnSaturation(shape.estimateMaxN());
@@ -86,7 +89,7 @@ public static final Predicate<LayerManager> advanceOnCalculatedFull(Shape shape)
          * the current target.
          *
          * @param breakAt the number of filters to merge into each filter in the list.
-         * @return a Predicate suitable for the LayerManager externCheck parameter.
+         * @return A Predicate suitable for the LayerManager extendCheck parameter.
          */
         public static Predicate<LayerManager> advanceOnCount(int breakAt) {
             return new Predicate<LayerManager>() {
@@ -108,7 +111,7 @@ public boolean test(LayerManager filter) {
          * estimation from the Shape use the double version of this function.
          *
          * @param maxN the maximum number of estimated items in the filter.
-         * @return a Predicate suitable for an ExtendCheck.
+         * @return A Predicate suitable for the LayerManager extendCheck parameter.
          */
         public static final Predicate<LayerManager> advanceOnSaturation(int maxN) {
             return new Predicate<LayerManager>() {
@@ -132,7 +135,7 @@ public boolean test(LayerManager manager) {
          * estimation from the Shape use the double version of this function.
          *
          * @param maxN the maximum number of estimated items in the filter.
-         * @return a Predicate suitable for an ExtendCheck.
+         * @return A Predicate suitable for the LayerManager extendCheck parameter.
          */
         public static final Predicate<LayerManager> advanceOnSaturation(double maxN) {
             return new Predicate<LayerManager>() {