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-text.git
The following commit(s) were added to refs/heads/master by this push:
new 3ed9b5db Javadoc
3ed9b5db is described below
commit 3ed9b5db4debb07953a69daca6c275ed1c8fd291
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Nov 28 13:29:28 2025 +0000
Javadoc
---
src/main/java/org/apache/commons/text/WordUtils.java | 4 ++--
.../org/apache/commons/text/similarity/FuzzyScore.java | 6 +++---
.../commons/text/similarity/JaroWinklerDistance.java | 12 ++++++------
.../commons/text/similarity/JaroWinklerSimilarity.java | 12 ++++++------
.../text/similarity/LevenshteinDetailedDistance.java | 18 +++++++++---------
.../commons/text/similarity/LevenshteinDistance.java | 18 +++++++++---------
6 files changed, 35 insertions(+), 35 deletions(-)
diff --git a/src/main/java/org/apache/commons/text/WordUtils.java
b/src/main/java/org/apache/commons/text/WordUtils.java
index ea84d548..83f2eec2 100644
--- a/src/main/java/org/apache/commons/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/text/WordUtils.java
@@ -73,8 +73,8 @@ public class WordUtils {
* WordUtils.abbreviate("Now is the time for all good men", 20, -1, ""));
= "Now is the time for all"
* WordUtils.abbreviate("Now is the time for all good men", 50, -1, ""));
= "Now is the time for all good men"
* WordUtils.abbreviate("Now is the time for all good men", 1000, -1,
"")); = "Now is the time for all good men"
- * WordUtils.abbreviate("Now is the time for all good men", 9, -10,
null)); = IllegalArgumentException
- * WordUtils.abbreviate("Now is the time for all good men", 10, 5, null));
= IllegalArgumentException
+ * WordUtils.abbreviate("Now is the time for all good men", 9, -10,
null)); = Throws {@link IllegalArgumentException}
+ * WordUtils.abbreviate("Now is the time for all good men", 10, 5, null));
= Throws {@link IllegalArgumentException}
* </pre>
*/
public static String abbreviate(final String str, int lower, int upper,
final String appendToEnd) {
diff --git a/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java
b/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java
index 78c96aff..fd5c447d 100644
--- a/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java
+++ b/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java
@@ -57,9 +57,9 @@ public class FuzzyScore {
* Find the Fuzzy Score which indicates the similarity score between two
Strings.
*
* <pre>
- * score.fuzzyScore(null, null) =
IllegalArgumentException
- * score.fuzzyScore("not null", null) =
IllegalArgumentException
- * score.fuzzyScore(null, "not null") =
IllegalArgumentException
+ * score.fuzzyScore(null, null) = Throws {@link
IllegalArgumentException}
+ * score.fuzzyScore("not null", null) = Throws {@link
IllegalArgumentException}
+ * score.fuzzyScore(null, "not null") = Throws {@link
IllegalArgumentException}
* score.fuzzyScore("", "") = 0
* score.fuzzyScore("Workshop", "b") = 0
* score.fuzzyScore("Room", "o") = 1
diff --git
a/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
b/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
index 5564b07b..cf11a864 100644
--- a/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
@@ -55,9 +55,9 @@ public class JaroWinklerDistance implements
EditDistance<Double> {
* Computes the Jaro Winkler Distance between two character sequences.
*
* <pre>
- * distance.apply(null, null) = IllegalArgumentException
- * distance.apply("foo", null) = IllegalArgumentException
- * distance.apply(null, "foo") = IllegalArgumentException
+ * distance.apply(null, null) = Throws {@link
IllegalArgumentException}
+ * distance.apply("foo", null) = Throws {@link
IllegalArgumentException}
+ * distance.apply(null, "foo") = Throws {@link
IllegalArgumentException}
* distance.apply("", "") = 0.0
* distance.apply("foo", "foo") = 0.0
* distance.apply("foo", "foo ") = 0.06
@@ -92,9 +92,9 @@ public class JaroWinklerDistance implements
EditDistance<Double> {
* Computes the Jaro Winkler Distance between two character sequences.
*
* <pre>
- * distance.apply(null, null) = IllegalArgumentException
- * distance.apply("foo", null) = IllegalArgumentException
- * distance.apply(null, "foo") = IllegalArgumentException
+ * distance.apply(null, null) = Throws {@link
IllegalArgumentException}
+ * distance.apply("foo", null) = Throws {@link
IllegalArgumentException}
+ * distance.apply(null, "foo") = Throws {@link
IllegalArgumentException}
* distance.apply("", "") = 0.0
* distance.apply("foo", "foo") = 0.0
* distance.apply("foo", "foo ") = 0.06
diff --git
a/src/main/java/org/apache/commons/text/similarity/JaroWinklerSimilarity.java
b/src/main/java/org/apache/commons/text/similarity/JaroWinklerSimilarity.java
index e42650fe..5e675958 100644
---
a/src/main/java/org/apache/commons/text/similarity/JaroWinklerSimilarity.java
+++
b/src/main/java/org/apache/commons/text/similarity/JaroWinklerSimilarity.java
@@ -130,9 +130,9 @@ public class JaroWinklerSimilarity implements
SimilarityScore<Double> {
* Computes the Jaro Winkler Similarity between two character sequences.
*
* <pre>
- * sim.apply(null, null) = IllegalArgumentException
- * sim.apply("foo", null) = IllegalArgumentException
- * sim.apply(null, "foo") = IllegalArgumentException
+ * sim.apply(null, null) = Throws {@link IllegalArgumentException}
+ * sim.apply("foo", null) = Throws {@link IllegalArgumentException}
+ * sim.apply(null, "foo") = Throws {@link IllegalArgumentException}
* sim.apply("", "") = 1.0
* sim.apply("foo", "foo") = 1.0
* sim.apply("foo", "foo ") = 0.94
@@ -167,9 +167,9 @@ public class JaroWinklerSimilarity implements
SimilarityScore<Double> {
* Computes the Jaro Winkler Similarity between two character sequences.
*
* <pre>
- * sim.apply(null, null) = IllegalArgumentException
- * sim.apply("foo", null) = IllegalArgumentException
- * sim.apply(null, "foo") = IllegalArgumentException
+ * sim.apply(null, null) = Throws {@link IllegalArgumentException}
+ * sim.apply("foo", null) = Throws {@link IllegalArgumentException}
+ * sim.apply(null, "foo") = Throws {@link IllegalArgumentException}
* sim.apply("", "") = 1.0
* sim.apply("foo", "foo") = 1.0
* sim.apply("foo", "foo ") = 0.94
diff --git
a/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
b/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
index bec6e7f1..556eaf1f 100644
---
a/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
+++
b/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
@@ -136,9 +136,9 @@ public class LevenshteinDetailedDistance implements
EditDistance<LevenshteinResu
* </p>
*
* <pre>
- * limitedCompare(null, *, *) = IllegalArgumentException
- * limitedCompare(*, null, *) = IllegalArgumentException
- * limitedCompare(*, *, -1) = IllegalArgumentException
+ * limitedCompare(null, *, *) = Throws {@link
IllegalArgumentException}
+ * limitedCompare(*, null, *) = Throws {@link
IllegalArgumentException}
+ * limitedCompare(*, *, -1) = Throws {@link
IllegalArgumentException}
* limitedCompare("","", 0) = 0
* limitedCompare("aaapppp", "", 8) = 7
* limitedCompare("aaapppp", "", 7) = 7
@@ -285,8 +285,8 @@ public class LevenshteinDetailedDistance implements
EditDistance<LevenshteinResu
* </p>
*
* <pre>
- * unlimitedCompare(null, *) = IllegalArgumentException
- * unlimitedCompare(*, null) = IllegalArgumentException
+ * unlimitedCompare(null, *) = Throws {@link
IllegalArgumentException}
+ * unlimitedCompare(*, null) = Throws {@link
IllegalArgumentException}
* unlimitedCompare("","") = 0
* unlimitedCompare("","a") = 1
* unlimitedCompare("aaapppp", "") = 7
@@ -428,8 +428,8 @@ public class LevenshteinDetailedDistance implements
EditDistance<LevenshteinResu
* </p>
*
* <pre>
- * distance.apply(null, *) = IllegalArgumentException
- * distance.apply(*, null) = IllegalArgumentException
+ * distance.apply(null, *) = Throws {@link
IllegalArgumentException}
+ * distance.apply(*, null) = Throws {@link
IllegalArgumentException}
* distance.apply("","") = 0
* distance.apply("","a") = 1
* distance.apply("aaapppp", "") = 7
@@ -471,8 +471,8 @@ public class LevenshteinDetailedDistance implements
EditDistance<LevenshteinResu
* </p>
*
* <pre>
- * distance.apply(null, *) = IllegalArgumentException
- * distance.apply(*, null) = IllegalArgumentException
+ * distance.apply(null, *) = Throws {@link
IllegalArgumentException}
+ * distance.apply(*, null) = Throws {@link
IllegalArgumentException}
* distance.apply("","") = 0
* distance.apply("","a") = 1
* distance.apply("aaapppp", "") = 7
diff --git
a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
index 7fdbc6fb..cb2e2729 100644
--- a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
@@ -59,9 +59,9 @@ public class LevenshteinDistance implements
EditDistance<Integer> {
* </p>
*
* <pre>
- * limitedCompare(null, *, *) = IllegalArgumentException
- * limitedCompare(*, null, *) = IllegalArgumentException
- * limitedCompare(*, *, -1) = IllegalArgumentException
+ * limitedCompare(null, *, *) = Throws {@link
IllegalArgumentException}
+ * limitedCompare(*, null, *) = Throws {@link
IllegalArgumentException}
+ * limitedCompare(*, *, -1) = Throws {@link
IllegalArgumentException}
* limitedCompare("","", 0) = 0
* limitedCompare("aaapppp", "", 8) = 7
* limitedCompare("aaapppp", "", 7) = 7
@@ -217,8 +217,8 @@ public class LevenshteinDistance implements
EditDistance<Integer> {
* </p>
*
* <pre>
- * unlimitedCompare(null, *) = IllegalArgumentException
- * unlimitedCompare(*, null) = IllegalArgumentException
+ * unlimitedCompare(null, *) = Throws {@link
IllegalArgumentException}
+ * unlimitedCompare(*, null) = Throws {@link
IllegalArgumentException}
* unlimitedCompare("","") = 0
* unlimitedCompare("","a") = 1
* unlimitedCompare("aaapppp", "") = 7
@@ -335,8 +335,8 @@ public class LevenshteinDistance implements
EditDistance<Integer> {
* </p>
*
* <pre>
- * distance.apply(null, *) = IllegalArgumentException
- * distance.apply(*, null) = IllegalArgumentException
+ * distance.apply(null, *) = Throws {@link
IllegalArgumentException}
+ * distance.apply(*, null) = Throws {@link
IllegalArgumentException}
* distance.apply("","") = 0
* distance.apply("","a") = 1
* distance.apply("aaapppp", "") = 7
@@ -366,8 +366,8 @@ public class LevenshteinDistance implements
EditDistance<Integer> {
* </p>
*
* <pre>
- * distance.apply(null, *) = IllegalArgumentException
- * distance.apply(*, null) = IllegalArgumentException
+ * distance.apply(null, *) = Throws {@link
IllegalArgumentException}
+ * distance.apply(*, null) = Throws {@link
IllegalArgumentException}
* distance.apply("","") = 0
* distance.apply("","a") = 1
* distance.apply("aaapppp", "") = 7
