Fix javadoc issues.

apache · Nov 16, 2023 · 4747f67 · 4747f67
1 parent 23e36ac
commit 4747f67
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/src/main/java/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.java b/src/main/java/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.java
@@ -83,17 +83,17 @@ public GenericPartitionBoundaries(
    * <p>If these results were computed using QuantileSearchCriteria.INCLUSIVE then these sequential boundaries
    * are to be interpreted as follows:
    * <ul>
-   * <li>Partition 1: include all items >= index 0 and <= index 1.</li>
-   * <li>Partition 2: include all items >  index 1 and <= index 2.</li>
-   * <li>Partition N: include all items >  index N-1 and <= index N.</li>
+   * <li>Partition 1: include all items &ge; index 0 and &le; index 1.</li>
+   * <li>Partition 2: include all items &gt; index 1 and &le; index 2.</li>
+   * <li>Partition N: include all items &gt; index N-1 and &le; index N.</li>
    * </ul>
    *
    * <p>If these results were computed using QuantileSearchCriteria.EXCLUSIVE then these sequential boundaries
    * are to be interpreted as follows:
    * <ul>
-   * <li>Partition 1: include all items >= index 0 and < index 1.</li>
-   * <li>Partition 2: include all items >= index 1 and < index 2.</li>
-   * <li>Partition N: include all items >= index N-1 and <= index N.</li>
+   * <li>Partition 1: include all items &ge; index 0 and &lt; index 1.</li>
+   * <li>Partition 2: include all items &ge; index 1 and &lt; index 2.</li>
+   * <li>Partition N: include all items &ge; index N-1 and &le; index N.</li>
    * </ul>
    *
    * @return an array of boundaries that sequentially define the upper and lower boundaries of partitions.

diff --git a/src/main/java/org/apache/datasketches/quantilescommon/PartitioningFeature.java b/src/main/java/org/apache/datasketches/quantilescommon/PartitioningFeature.java
@@ -37,7 +37,8 @@ public interface PartitioningFeature<T> {
    * </p>
    *
    * @param numEquallySized an integer that specifies the number of equally sized partitions between
-   * {@link #getMinItem() getMinItem()} and {@link #getMaxItem() getMaxItem()}.
+   * {@link GenericPartitionBoundaries#getMinItem() getMinItem()} and
+   * {@link GenericPartitionBoundaries#getMaxItem() getMaxItem()}.
    * This must be a positive integer greater than zero.
    * <ul>
    * <li>A 1 will return: minItem, maxItem.</li>
@@ -60,7 +61,8 @@ default GenericPartitionBoundaries<T> getPartitionBoundaries(int numEquallySized
    * refers to an approximately equal number of items per partition.
    *
    * @param numEquallySized an integer that specifies the number of equally sized partitions between
-   * {@link #getMinItem() getMinItem()} and {@link #getMaxItem() getMaxItem()}.
+   * {@link GenericPartitionBoundaries#getMinItem() getMinItem()} and
+   * {@link GenericPartitionBoundaries#getMaxItem() getMaxItem()}.
    * This must be a positive integer greater than zero.
    * <ul>
    * <li>A 1 will return: minItem, maxItem.</li>