Improve Javadoc wording

Author: leerho

src/main/java/org/apache/datasketches/quantiles/DirectUpdateDoublesSketch.java

@@ -87,7 +87,7 @@ private DirectUpdateDoublesSketch(final int k, final MemorySegment seg, final Me
    * @param dstSeg the non-null destination MemorySegment that will be initialized to hold the data for this sketch.
    * It must initially be at least (16 * MIN_K + 32) bytes, where MIN_K defaults to 2. As it grows
    * it will request more MemorySegment using the MemorySegmentRequest callback.
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a DirectUpdateDoublesSketch
    */
@@ -117,7 +117,7 @@ static DirectUpdateDoublesSketch newInstance(final int k, final MemorySegment ds
    * Wrap this sketch around the given updatable MemorySegment image of a DoublesSketch.
    *
    * @param srcSeg the given MemorySegment image of an UpdateDoublesSketch and must not be null.
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a sketch that wraps the given srcSeg
    */

src/main/java/org/apache/datasketches/quantiles/DoublesSketch.java

@@ -154,8 +154,8 @@ public static DoublesSketch heapify(final MemorySegment srcSeg) {
    * Wrap this sketch around the given updatable MemorySegment image of a DoublesSketch, compact or updatable.
    *
    * @param srcSeg the given MemorySegment image of a DoublesSketch that may have data
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment is in updatable form and needs to expand.
-   * Otherwise, it can be null.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
+   * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a sketch that wraps the given srcSeg in read-only mode.
    */
   public static DoublesSketch wrap(final MemorySegment srcSeg, final MemorySegmentRequest mSegReq) {
@@ -394,7 +394,7 @@ public static String toString(final MemorySegment seg) {
    * It is required that this.getK() = smallerK * 2^(nonnegative integer).
    * @param dstSeg the destination MemorySegment.  It must not overlap the MemorySegment of this sketch.
    * If null, a heap sketch will be returned, otherwise it will be MemorySegment based.
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return the new sketch.
    */

src/main/java/org/apache/datasketches/quantiles/DoublesSketchBuilder.java

@@ -87,7 +87,7 @@ public UpdateDoublesSketch build(final MemorySegment dstSeg) {
    * Returns a UpdateDoublesSketch with the current configuration of this builder
    * and the specified backing destination MemorySegment store that can grow.
    * @param dstSeg destination MemorySegment for use by the sketch
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return an UpdateDoublesSketch
    */

src/main/java/org/apache/datasketches/quantiles/DoublesUnion.java

@@ -64,7 +64,7 @@ public static DoublesUnion heapify(final MemorySegment srcSeg) {
    * The data structures of the Union remain in the MemorySegment.
    *
    * @param srcSeg A MemorySegment to be used as the data structure for the sketch and will be modified.
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a Union object
    */
@@ -151,7 +151,7 @@ public static DoublesUnion writableWrap(final MemorySegment srcSeg, final Memory
    * been changed, which allows further union operations.
    *
    * @param dstSeg the destination MemorySegment for the result
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return the result of this Union operation
    */

src/main/java/org/apache/datasketches/quantiles/DoublesUnionBuilder.java

@@ -74,7 +74,7 @@ public DoublesUnion build() {
    * Returns a new empty Union object with the current configuration of this Builder
    * and the specified backing destination MemorySegment store.
    * @param dstSeg the destination MemorySegment
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a Union object
    */

src/main/java/org/apache/datasketches/quantiles/DoublesUnionImpl.java

@@ -64,7 +64,7 @@ static DoublesUnionImpl heapInstance(final int maxK) {
    * It is recommended that <i>maxK</i> be a power of 2 to enable unioning of sketches with
    * different <i>k</i>.
    * @param dstSeg the MemorySegment to be used by the internal sketch and must not be null.
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a DoublesUnion object
    */
@@ -115,7 +115,7 @@ static DoublesUnionImpl heapifyInstance(final MemorySegment srcSeg) {
    * image of a updatable DoublesSketch. The data of the Union will remain in the MemorySegment.
    *
    * @param srcSeg A writable MemorySegment image of a updatable DoublesSketch to be used as data for the union.
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a Union object
    */

src/main/java/org/apache/datasketches/quantiles/UpdateDoublesSketch.java

@@ -37,7 +37,7 @@ public abstract class UpdateDoublesSketch extends DoublesSketch {
    * Wrap this sketch around the given MemorySegment image of an UpdateDoublesSketch.
    *
    * @param srcSeg the given MemorySegment image of an UpdateDoublesSketch and must not be null.
-   * @param mSegReq the MemorySegmentRequest used if the incoming MemorySegment needs to expand.
+   * @param mSegReq the MemorySegmentRequest used if the given MemorySegment needs to expand.
    * Otherwise, it can be null and the default MemorySegmentRequest will be used.
    * @return a sketch that wraps the given srcSeg
    */