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 479be9e85 Javadoc
479be9e85 is described below

commit 479be9e8598d5b68516017280a022daa6209e3dc
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Nov 28 13:25:23 2025 +0000

    Javadoc
---
 src/main/java/org/apache/commons/lang3/ArrayUtils.java |  6 +++---
 .../java/org/apache/commons/lang3/StringUtils.java     | 18 +++++++++---------
 2 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java 
b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
index f336c785e..208920f78 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
@@ -756,7 +756,7 @@ public static short[] add(final short[] array, final short 
element) {
      * whose component type is the same as the element.
      * </p>
      * <pre>
-     * ArrayUtils.add(null, 0, null)      = IllegalArgumentException
+     * ArrayUtils.add(null, 0, null)      = Throws {@link 
IllegalArgumentException}
      * ArrayUtils.add(null, 0, "a")       = ["a"]
      * ArrayUtils.add(["a"], 1, null)     = ["a", null]
      * ArrayUtils.add(["a"], 1, "b")      = ["a", "b"]
@@ -800,7 +800,7 @@ public static <T> T[] add(final T[] array, final int index, 
final T element) {
      * in which case the return type is Object[]
      * </p>
      * <pre>
-     * ArrayUtils.add(null, null)      = IllegalArgumentException
+     * ArrayUtils.add(null, null)      = Throws {@link 
IllegalArgumentException}
      * ArrayUtils.add(null, "a")       = ["a"]
      * ArrayUtils.add(["a"], null)     = ["a", null]
      * ArrayUtils.add(["a"], "b")      = ["a", "b"]
@@ -1360,7 +1360,7 @@ public static short[] addFirst(final short[] array, final 
short element) {
      * element, unless the element itself is null, in which case the return 
type is Object[]
      * </p>
      * <pre>
-     * ArrayUtils.addFirst(null, null)      = IllegalArgumentException
+     * ArrayUtils.addFirst(null, null)      = Throws {@link 
IllegalArgumentException}
      * ArrayUtils.addFirst(null, "a")       = ["a"]
      * ArrayUtils.addFirst(["a"], null)     = [null, "a"]
      * ArrayUtils.addFirst(["a"], "b")      = ["b", "a"]
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java 
b/src/main/java/org/apache/commons/lang3/StringUtils.java
index a8fa431d9..54f9b69d9 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -2063,7 +2063,7 @@ public static String getDigits(final String str) {
      * </p>
      *
      * <pre>
-     * StringUtils.getFuzzyDistance(null, null, null)                          
          = IllegalArgumentException
+     * StringUtils.getFuzzyDistance(null, null, null)                          
          = Throws {@link IllegalArgumentException}
      * StringUtils.getFuzzyDistance("", "", Locale.ENGLISH)                    
          = 0
      * StringUtils.getFuzzyDistance("Workshop", "b", Locale.ENGLISH)           
          = 0
      * StringUtils.getFuzzyDistance("Room", "o", Locale.ENGLISH)               
          = 1
@@ -2205,7 +2205,7 @@ public static <T extends CharSequence> T getIfEmpty(final 
T str, final Supplier<
      * </p>
      *
      * <pre>
-     * StringUtils.getJaroWinklerDistance(null, null)          = 
IllegalArgumentException
+     * StringUtils.getJaroWinklerDistance(null, null)          = Throws {@link 
IllegalArgumentException}
      * StringUtils.getJaroWinklerDistance("", "")              = 0.0
      * StringUtils.getJaroWinklerDistance("", "a")             = 0.0
      * StringUtils.getJaroWinklerDistance("aaapppp", "")       = 0.0
@@ -2263,8 +2263,8 @@ public static double getJaroWinklerDistance(final 
CharSequence first, final Char
      * </p>
      *
      * <pre>
-     * StringUtils.getLevenshteinDistance(null, *)             = 
IllegalArgumentException
-     * StringUtils.getLevenshteinDistance(*, null)             = 
IllegalArgumentException
+     * StringUtils.getLevenshteinDistance(null, *)             = Throws {@link 
IllegalArgumentException}
+     * StringUtils.getLevenshteinDistance(*, null)             = Throws {@link 
IllegalArgumentException}
      * StringUtils.getLevenshteinDistance("", "")              = 0
      * StringUtils.getLevenshteinDistance("", "a")             = 1
      * StringUtils.getLevenshteinDistance("aaapppp", "")       = 7
@@ -2355,9 +2355,9 @@ public static int getLevenshteinDistance(CharSequence s, 
CharSequence t) {
      * </p>
      *
      * <pre>
-     * StringUtils.getLevenshteinDistance(null, *, *)             = 
IllegalArgumentException
-     * StringUtils.getLevenshteinDistance(*, null, *)             = 
IllegalArgumentException
-     * StringUtils.getLevenshteinDistance(*, *, -1)               = 
IllegalArgumentException
+     * StringUtils.getLevenshteinDistance(null, *, *)             = Throws 
{@link IllegalArgumentException}
+     * StringUtils.getLevenshteinDistance(*, null, *)             = Throws 
{@link IllegalArgumentException}
+     * StringUtils.getLevenshteinDistance(*, *, -1)               = Throws 
{@link IllegalArgumentException}
      * StringUtils.getLevenshteinDistance("", "", 0)              = 0
      * StringUtils.getLevenshteinDistance("aaapppp", "", 8)       = 7
      * StringUtils.getLevenshteinDistance("aaapppp", "", 7)       = 7
@@ -6385,7 +6385,7 @@ public static String replaceEach(final String text, final 
String[] searchList, f
      *  (example of how it repeats)
      *  StringUtils.replaceEach("abcde", new String[]{"ab", "d"}, new 
String[]{"d", "t"}, false, >=0) = "dcte"
      *  StringUtils.replaceEach("abcde", new String[]{"ab", "d"}, new 
String[]{"d", "t"}, true, >=2)  = "tcte"
-     *  StringUtils.replaceEach("abcde", new String[]{"ab", "d"}, new 
String[]{"d", "ab"}, *, *)      = IllegalStateException
+     *  StringUtils.replaceEach("abcde", new String[]{"ab", "d"}, new 
String[]{"d", "ab"}, *, *)      = Throws {@link IllegalStateException}
      * </pre>
      *
      * @param text            text to search and replace in, no-op if null.
@@ -6536,7 +6536,7 @@ private static String replaceEach(
      *  StringUtils.replaceEachRepeatedly("abcde", new String[]{"ab", "d"}, 
new String[]{"w", "t"})  = "wcte"
      *  (example of how it repeats)
      *  StringUtils.replaceEachRepeatedly("abcde", new String[]{"ab", "d"}, 
new String[]{"d", "t"})  = "tcte"
-     *  StringUtils.replaceEachRepeatedly("abcde", new String[]{"ab", "d"}, 
new String[]{"d", "ab"}) = IllegalStateException
+     *  StringUtils.replaceEachRepeatedly("abcde", new String[]{"ab", "d"}, 
new String[]{"d", "ab"}) = Throws {@link IllegalStateException}
      * </pre>
      *
      * @param text            text to search and replace in, no-op if null.

Reply via email to