Skip to content

Commit 3ed9b5d

Browse files
garydgregorygarydgregory
committed
Javadoc
1 parent 3f5295b commit 3ed9b5d

File tree

6 files changed

+35
-35
lines changed

6 files changed

+35
-35
lines changed

‎src/main/java/org/apache/commons/text/WordUtils.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ public class WordUtils {
7373
* WordUtils.abbreviate("Now is the time for all good men", 20, -1, "")); = "Now is the time for all"
7474
* WordUtils.abbreviate("Now is the time for all good men", 50, -1, "")); = "Now is the time for all good men"
7575
* WordUtils.abbreviate("Now is the time for all good men", 1000, -1, "")); = "Now is the time for all good men"
76-
* WordUtils.abbreviate("Now is the time for all good men", 9, -10, null)); = IllegalArgumentException
77-
* WordUtils.abbreviate("Now is the time for all good men", 10, 5, null)); = IllegalArgumentException
76+
* WordUtils.abbreviate("Now is the time for all good men", 9, -10, null)); = Throws {@link IllegalArgumentException}
77+
* WordUtils.abbreviate("Now is the time for all good men", 10, 5, null)); = Throws {@link IllegalArgumentException}
7878
* </pre>
7979
*/
8080
public static String abbreviate(final String str, int lower, int upper, final String appendToEnd) {

‎src/main/java/org/apache/commons/text/similarity/FuzzyScore.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ public FuzzyScore(final Locale locale) {
5757
* Find the Fuzzy Score which indicates the similarity score between two Strings.
5858
*
5959
* <pre>
60-
* score.fuzzyScore(null, null) = IllegalArgumentException
61-
* score.fuzzyScore("not null", null) = IllegalArgumentException
62-
* score.fuzzyScore(null, "not null") = IllegalArgumentException
60+
* score.fuzzyScore(null, null) = Throws {@link IllegalArgumentException}
61+
* score.fuzzyScore("not null", null) = Throws {@link IllegalArgumentException}
62+
* score.fuzzyScore(null, "not null") = Throws {@link IllegalArgumentException}
6363
* score.fuzzyScore("", "") = 0
6464
* score.fuzzyScore("Workshop", "b") = 0
6565
* score.fuzzyScore("Room", "o") = 1

‎src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ public JaroWinklerDistance() {
5555
* Computes the Jaro Winkler Distance between two character sequences.
5656
*
5757
* <pre>
58-
* distance.apply(null, null) = IllegalArgumentException
59-
* distance.apply("foo", null) = IllegalArgumentException
60-
* distance.apply(null, "foo") = IllegalArgumentException
58+
* distance.apply(null, null) = Throws {@link IllegalArgumentException}
59+
* distance.apply("foo", null) = Throws {@link IllegalArgumentException}
60+
* distance.apply(null, "foo") = Throws {@link IllegalArgumentException}
6161
* distance.apply("", "") = 0.0
6262
* distance.apply("foo", "foo") = 0.0
6363
* distance.apply("foo", "foo ") = 0.06
@@ -92,9 +92,9 @@ public Double apply(final CharSequence left, final CharSequence right) {
9292
* Computes the Jaro Winkler Distance between two character sequences.
9393
*
9494
* <pre>
95-
* distance.apply(null, null) = IllegalArgumentException
96-
* distance.apply("foo", null) = IllegalArgumentException
97-
* distance.apply(null, "foo") = IllegalArgumentException
95+
* distance.apply(null, null) = Throws {@link IllegalArgumentException}
96+
* distance.apply("foo", null) = Throws {@link IllegalArgumentException}
97+
* distance.apply(null, "foo") = Throws {@link IllegalArgumentException}
9898
* distance.apply("", "") = 0.0
9999
* distance.apply("foo", "foo") = 0.0
100100
* distance.apply("foo", "foo ") = 0.06

‎src/main/java/org/apache/commons/text/similarity/JaroWinklerSimilarity.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,9 @@ public JaroWinklerSimilarity() {
130130
* Computes the Jaro Winkler Similarity between two character sequences.
131131
*
132132
* <pre>
133-
* sim.apply(null, null) = IllegalArgumentException
134-
* sim.apply("foo", null) = IllegalArgumentException
135-
* sim.apply(null, "foo") = IllegalArgumentException
133+
* sim.apply(null, null) = Throws {@link IllegalArgumentException}
134+
* sim.apply("foo", null) = Throws {@link IllegalArgumentException}
135+
* sim.apply(null, "foo") = Throws {@link IllegalArgumentException}
136136
* sim.apply("", "") = 1.0
137137
* sim.apply("foo", "foo") = 1.0
138138
* sim.apply("foo", "foo ") = 0.94
@@ -167,9 +167,9 @@ public Double apply(final CharSequence left, final CharSequence right) {
167167
* Computes the Jaro Winkler Similarity between two character sequences.
168168
*
169169
* <pre>
170-
* sim.apply(null, null) = IllegalArgumentException
171-
* sim.apply("foo", null) = IllegalArgumentException
172-
* sim.apply(null, "foo") = IllegalArgumentException
170+
* sim.apply(null, null) = Throws {@link IllegalArgumentException}
171+
* sim.apply("foo", null) = Throws {@link IllegalArgumentException}
172+
* sim.apply(null, "foo") = Throws {@link IllegalArgumentException}
173173
* sim.apply("", "") = 1.0
174174
* sim.apply("foo", "foo") = 1.0
175175
* sim.apply("foo", "foo ") = 0.94

‎src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,9 @@ public static LevenshteinDetailedDistance getDefaultInstance() {
136136
* </p>
137137
*
138138
* <pre>
139-
* limitedCompare(null, *, *) = IllegalArgumentException
140-
* limitedCompare(*, null, *) = IllegalArgumentException
141-
* limitedCompare(*, *, -1) = IllegalArgumentException
139+
* limitedCompare(null, *, *) = Throws {@link IllegalArgumentException}
140+
* limitedCompare(*, null, *) = Throws {@link IllegalArgumentException}
141+
* limitedCompare(*, *, -1) = Throws {@link IllegalArgumentException}
142142
* limitedCompare("","", 0) = 0
143143
* limitedCompare("aaapppp", "", 8) = 7
144144
* limitedCompare("aaapppp", "", 7) = 7
@@ -285,8 +285,8 @@ private static <E> LevenshteinResults limitedCompare(SimilarityInput<E> left, Si
285285
* </p>
286286
*
287287
* <pre>
288-
* unlimitedCompare(null, *) = IllegalArgumentException
289-
* unlimitedCompare(*, null) = IllegalArgumentException
288+
* unlimitedCompare(null, *) = Throws {@link IllegalArgumentException}
289+
* unlimitedCompare(*, null) = Throws {@link IllegalArgumentException}
290290
* unlimitedCompare("","") = 0
291291
* unlimitedCompare("","a") = 1
292292
* unlimitedCompare("aaapppp", "") = 7
@@ -428,8 +428,8 @@ public LevenshteinDetailedDistance(final Integer threshold) {
428428
* </p>
429429
*
430430
* <pre>
431-
* distance.apply(null, *) = IllegalArgumentException
432-
* distance.apply(*, null) = IllegalArgumentException
431+
* distance.apply(null, *) = Throws {@link IllegalArgumentException}
432+
* distance.apply(*, null) = Throws {@link IllegalArgumentException}
433433
* distance.apply("","") = 0
434434
* distance.apply("","a") = 1
435435
* distance.apply("aaapppp", "") = 7
@@ -471,8 +471,8 @@ public LevenshteinResults apply(final CharSequence left, final CharSequence righ
471471
* </p>
472472
*
473473
* <pre>
474-
* distance.apply(null, *) = IllegalArgumentException
475-
* distance.apply(*, null) = IllegalArgumentException
474+
* distance.apply(null, *) = Throws {@link IllegalArgumentException}
475+
* distance.apply(*, null) = Throws {@link IllegalArgumentException}
476476
* distance.apply("","") = 0
477477
* distance.apply("","a") = 1
478478
* distance.apply("aaapppp", "") = 7

‎src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ public static LevenshteinDistance getDefaultInstance() {
5959
* </p>
6060
*
6161
* <pre>
62-
* limitedCompare(null, *, *) = IllegalArgumentException
63-
* limitedCompare(*, null, *) = IllegalArgumentException
64-
* limitedCompare(*, *, -1) = IllegalArgumentException
62+
* limitedCompare(null, *, *) = Throws {@link IllegalArgumentException}
63+
* limitedCompare(*, null, *) = Throws {@link IllegalArgumentException}
64+
* limitedCompare(*, *, -1) = Throws {@link IllegalArgumentException}
6565
* limitedCompare("","", 0) = 0
6666
* limitedCompare("aaapppp", "", 8) = 7
6767
* limitedCompare("aaapppp", "", 7) = 7
@@ -217,8 +217,8 @@ private static <E> int limitedCompare(SimilarityInput<E> left, SimilarityInput<E
217217
* </p>
218218
*
219219
* <pre>
220-
* unlimitedCompare(null, *) = IllegalArgumentException
221-
* unlimitedCompare(*, null) = IllegalArgumentException
220+
* unlimitedCompare(null, *) = Throws {@link IllegalArgumentException}
221+
* unlimitedCompare(*, null) = Throws {@link IllegalArgumentException}
222222
* unlimitedCompare("","") = 0
223223
* unlimitedCompare("","a") = 1
224224
* unlimitedCompare("aaapppp", "") = 7
@@ -335,8 +335,8 @@ public LevenshteinDistance(final Integer threshold) {
335335
* </p>
336336
*
337337
* <pre>
338-
* distance.apply(null, *) = IllegalArgumentException
339-
* distance.apply(*, null) = IllegalArgumentException
338+
* distance.apply(null, *) = Throws {@link IllegalArgumentException}
339+
* distance.apply(*, null) = Throws {@link IllegalArgumentException}
340340
* distance.apply("","") = 0
341341
* distance.apply("","a") = 1
342342
* distance.apply("aaapppp", "") = 7
@@ -366,8 +366,8 @@ public Integer apply(final CharSequence left, final CharSequence right) {
366366
* </p>
367367
*
368368
* <pre>
369-
* distance.apply(null, *) = IllegalArgumentException
370-
* distance.apply(*, null) = IllegalArgumentException
369+
* distance.apply(null, *) = Throws {@link IllegalArgumentException}
370+
* distance.apply(*, null) = Throws {@link IllegalArgumentException}
371371
* distance.apply("","") = 0
372372
* distance.apply("","a") = 1
373373
* distance.apply("aaapppp", "") = 7

0 commit comments

Comments
 (0)