Skip to content

Commit c819ed7

Browse files
committed
Javadoc
1 parent 74e54ee commit c819ed7

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

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

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,8 @@ public class FuzzyScore {
4343
/**
4444
* This returns a {@link Locale}-specific {@link FuzzyScore}.
4545
*
46-
* @param locale The string matching logic is case insensitive.
47-
A {@link Locale} is necessary to normalize both Strings to lower case.
48-
* @throws IllegalArgumentException
49-
* This is thrown if the {@link Locale} parameter is {@code null}.
46+
* @param locale The string matching logic is case insensitive. A {@link Locale} is necessary to normalize both Strings to lower case.
47+
* @throws IllegalArgumentException This is thrown if the {@link Locale} parameter is {@code null}.
5048
*/
5149
public FuzzyScore(final Locale locale) {
5250
if (locale == null) {
@@ -56,8 +54,7 @@ public FuzzyScore(final Locale locale) {
5654
}
5755

5856
/**
59-
* Find the Fuzzy Score which indicates the similarity score between two
60-
* Strings.
57+
* Find the Fuzzy Score which indicates the similarity score between two Strings.
6158
*
6259
* <pre>
6360
* score.fuzzyScore(null, null) = IllegalArgumentException
@@ -72,11 +69,10 @@ public FuzzyScore(final Locale locale) {
7269
* score.fuzzyScore("Apache Software Foundation", "asf") = 3
7370
* </pre>
7471
*
75-
* @param term a full term that should be matched against, must not be null
76-
* @param query the query that will be matched against a term, must not be
77-
* null
78-
* @return result score
79-
* @throws IllegalArgumentException if the term or query is {@code null}
72+
* @param term a full term that should be matched against, must not be null.
73+
* @param query the query that will be matched against a term, must not be null.
74+
* @return result score.
75+
* @throws IllegalArgumentException if the term or query is {@code null}.
8076
*/
8177
public Integer fuzzyScore(final CharSequence term, final CharSequence query) {
8278
if (term == null || query == null) {

0 commit comments

Comments
 (0)