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
commit 685da724c45e74d30df08215bb96bbafdeac4ed6 Author: Gary Gregory <[email protected]> AuthorDate: Sun Nov 30 08:13:52 2025 -0500 Javadoc --- src/main/java/org/apache/commons/text/diff/CommandVisitor.java | 3 +-- src/main/java/org/apache/commons/text/diff/EditScript.java | 2 +- .../java/org/apache/commons/text/diff/ReplacementsFinder.java | 2 +- .../java/org/apache/commons/text/diff/ReplacementsHandler.java | 2 +- src/main/java/org/apache/commons/text/diff/StringsComparator.java | 3 +-- src/main/java/org/apache/commons/text/similarity/FuzzyScore.java | 2 +- .../commons/text/similarity/LevenshteinDetailedDistance.java | 8 ++++---- .../org/apache/commons/text/similarity/SimilarityScoreFrom.java | 6 +++--- .../java/org/apache/commons/text/translate/CsvTranslators.java | 2 +- 9 files changed, 14 insertions(+), 16 deletions(-) diff --git a/src/main/java/org/apache/commons/text/diff/CommandVisitor.java b/src/main/java/org/apache/commons/text/diff/CommandVisitor.java index 187c9f41..247e0818 100644 --- a/src/main/java/org/apache/commons/text/diff/CommandVisitor.java +++ b/src/main/java/org/apache/commons/text/diff/CommandVisitor.java @@ -17,8 +17,7 @@ package org.apache.commons.text.diff; /** - * This interface should be implemented by user object to walk - * through {@link EditScript EditScript} objects. + * Walks through {@link EditScript EditScript} objects. * <p> * Users should implement this interface in order to walk through * the {@link EditScript EditScript} object created by the comparison diff --git a/src/main/java/org/apache/commons/text/diff/EditScript.java b/src/main/java/org/apache/commons/text/diff/EditScript.java index 6b68424b..420754ad 100644 --- a/src/main/java/org/apache/commons/text/diff/EditScript.java +++ b/src/main/java/org/apache/commons/text/diff/EditScript.java @@ -20,7 +20,7 @@ import java.util.ArrayList; import java.util.List; /** - * This class gathers all the {@link EditCommand commands} needed to transform + * Gathers all the {@link EditCommand commands} needed to transform * one objects sequence into another objects sequence. * <p> * An edit script is the most general view of the differences between two diff --git a/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java b/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java index 15f2ed5f..88994ac7 100644 --- a/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java +++ b/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java @@ -20,7 +20,7 @@ import java.util.ArrayList; import java.util.List; /** - * This class handles sequences of replacements resulting from a comparison. + * Handles sequences of replacements resulting from a comparison. * <p> * The comparison of two objects sequences leads to the identification of common * parts and parts which only belong to the first or to the second sequence. The diff --git a/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java b/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java index 3f8040ad..1b749b1f 100644 --- a/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java +++ b/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java @@ -19,7 +19,7 @@ package org.apache.commons.text.diff; import java.util.List; /** - * This interface is devoted to handle synchronized replacement sequences. + * Handles synchronized replacement sequences. * * @param <T> object type * @see ReplacementsFinder diff --git a/src/main/java/org/apache/commons/text/diff/StringsComparator.java b/src/main/java/org/apache/commons/text/diff/StringsComparator.java index db7ff5ac..74ff0e62 100644 --- a/src/main/java/org/apache/commons/text/diff/StringsComparator.java +++ b/src/main/java/org/apache/commons/text/diff/StringsComparator.java @@ -53,8 +53,7 @@ package org.apache.commons.text.diff; public class StringsComparator { /** - * This class is a simple placeholder to hold the end part of a path - * under construction in a {@link StringsComparator StringsComparator}. + * Holds the end part of a path under construction in a {@link StringsComparator StringsComparator}. */ private static final class Snake { 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 b35455dc..e1b605da 100644 --- a/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java +++ b/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java @@ -41,7 +41,7 @@ public class FuzzyScore { private final Locale locale; /** - * This returns a {@link Locale}-specific {@link FuzzyScore}. + * Constructs a new instance for a {@link Locale}-specific {@link FuzzyScore}. * * @param locale The string matching logic is case insensitive. A {@link Locale} is necessary to normalize both Strings to lower case. * @throws IllegalArgumentException This is thrown if the {@link Locale} parameter is {@code null}. 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 556eaf1f..d4148de4 100644 --- a/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java +++ b/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java @@ -380,9 +380,7 @@ public class LevenshteinDetailedDistance implements EditDistance<LevenshteinResu private final Integer threshold; /** - * <p> - * This returns the default instance that uses a version of the algorithm that does not use a threshold parameter. - * </p> + * Constructs a new instance that uses a version of the algorithm that does not use a threshold parameter. * * @see LevenshteinDetailedDistance#getDefaultInstance() * @deprecated Use {@link #getDefaultInstance()}. @@ -393,8 +391,10 @@ public class LevenshteinDetailedDistance implements EditDistance<LevenshteinResu } /** + * Constructs a new instance for a threshold. + * <p> * If the threshold is not null, distance calculations will be limited to a maximum length. - * + * </p> * <p> * If the threshold is null, the unlimited version of the algorithm will be used. * </p> diff --git a/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java b/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java index 470bb713..6e7078a1 100644 --- a/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java +++ b/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java @@ -19,7 +19,7 @@ package org.apache.commons.text.similarity; import org.apache.commons.lang3.Validate; /** - * This stores a {@link SimilarityScore} implementation and a {@link CharSequence} "left" string. + * Stores a {@link SimilarityScore} implementation and a {@link CharSequence} "left" string. * The {@link #apply(CharSequence right)} method accepts the "right" string and invokes the * comparison function for the pair of strings. * @@ -63,7 +63,7 @@ public class SimilarityScoreFrom<R> { private final CharSequence left; /** - * This accepts the similarity score implementation and the "left" string. + * Constructs a new instance for a similarity score implementation and the "left" string. * * @param similarityScore This may not be null. * @param left This may be null here, @@ -78,7 +78,7 @@ public class SimilarityScoreFrom<R> { } /** - * This compares "left" field against the "right" parameter + * Compares "left" field against the "right" parameter * using the "similarity score" implementation. * * @param right the second CharSequence. diff --git a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java index 053dc174..9a5f4671 100644 --- a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java +++ b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java @@ -24,7 +24,7 @@ import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.Strings; /** - * This class holds inner classes for escaping/unescaping Comma Separated Values. + * Holds inner classes for escaping/unescaping Comma Separated Values. * <p> * In general the use a high level API like <a href="https://commons.apache.org/proper/commons-csv/";>Apache Commons * CSV</a> should be preferred over these low level classes.
