[commons-lang] branch master updated: Update Javadoc to match implementation details.

[gg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git


The following commit(s) were added to refs/heads/master by this push:
     new 766a8da  Update Javadoc to match implementation details.
766a8da is described below

commit 766a8daa992ffe9ba793a7c521f67ec81640c1ca
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Dec 8 08:28:05 2021 -0500

    Update Javadoc to match implementation details.
---
 src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java | 6 +++---
 src/main/java/org/apache/commons/lang3/tuple/MutablePair.java   | 6 +++---
 src/main/java/org/apache/commons/lang3/tuple/Pair.java          | 6 +++---
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java b/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
index 5b85893..7c52b6c 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
@@ -115,15 +115,15 @@ public final class ImmutablePair<L, R> extends Pair<L, R> {
     }
 
     /**
-     * <p>Creates an immutable pair from an existing pair.</p>
+     * <p>Creates an immutable pair from a map entry.</p>
      *
      * <p>This factory allows the pair to be created using inference to
      * obtain the generic types.</p>
      *
      * @param <L> the left element type
      * @param <R> the right element type
-     * @param pair the existing pair.
-     * @return a pair formed from the two parameters, not null
+     * @param pair the existing map entry.
+     * @return a pair formed from the map entry
      * @since 3.10
      */
     public static <L, R> ImmutablePair<L, R> of(final Map.Entry<L, R> pair) {
diff --git a/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java b/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
index cc23f7f..7347951 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
@@ -75,15 +75,15 @@ public class MutablePair<L, R> extends Pair<L, R> {
     }
 
     /**
-     * <p>Creates a mutable pair from an existing pair.</p>
+     * <p>Creates a mutable pair from a map entry.</p>
      *
      * <p>This factory allows the pair to be created using inference to
      * obtain the generic types.</p>
      *
      * @param <L> the left element type
      * @param <R> the right element type
-     * @param pair the existing pair.
-     * @return a pair formed from the two parameters, not null
+     * @param pair the existing map entry.
+     * @return a pair formed from the map entry
      */
     public static <L, R> MutablePair<L, R> of(final Map.Entry<L, R> pair) {
         final L left;
diff --git a/src/main/java/org/apache/commons/lang3/tuple/Pair.java b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
index 628213c..0d52881 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/Pair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
@@ -105,15 +105,15 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
     }
 
     /**
-     * <p>Creates an immutable pair from an existing pair.</p>
+     * <p>Creates an immutable pair from a map entry.</p>
      *
      * <p>This factory allows the pair to be created using inference to
      * obtain the generic types.</p>
      *
      * @param <L> the left element type
      * @param <R> the right element type
-     * @param pair the existing pair.
-     * @return a pair formed from the two parameters, not null
+     * @param pair the map entry.
+     * @return a pair formed from the map entry
      * @since 3.10
      */
     public static <L, R> Pair<L, R> of(final Map.Entry<L, R> pair) {