Javadoc

Author: garydgregory

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

src/main/java/org/apache/commons/text/diff/EditScript.java

@@ -20,7 +20,7 @@
 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

src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java

@@ -20,7 +20,7 @@
 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

src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java

@@ -19,7 +19,7 @@
 import java.util.List;
 
 /**
- * This interface is devoted to handle synchronized replacement sequences.
+ * Handles synchronized replacement sequences.
  *
  * @param <T> object type
  * @see ReplacementsFinder

src/main/java/org/apache/commons/text/diff/StringsComparator.java

@@ -53,8 +53,7 @@
 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 {
 

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}.

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

@@ -380,9 +380,7 @@ private static <E> LevenshteinResults unlimitedCompare(SimilarityInput<E> left,
     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 LevenshteinDetailedDistance() {
     }
 
     /**
+     * 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>

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

@@ -19,7 +19,7 @@
 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 SimilarityScoreFrom(final SimilarityScore<R> similarityScore, final CharS
     }
 
     /**
-     * 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.

src/main/java/org/apache/commons/text/translate/CsvTranslators.java

@@ -24,7 +24,7 @@
 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.