Javadoc

Author: garydgregory

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

@@ -33,9 +33,9 @@ public class DamerauLevenshteinDistance implements EditDistance<Integer> {
     /**
      * Utility function to ensure distance is valid according to threshold.
      *
-     * @param distance  The distance value
-     * @param threshold The threshold value
-     * @return The distance value, or {@code -1} if distance is greater than threshold
+     * @param distance  The distance value.
+     * @param threshold The threshold value.
+     * @return The distance value, or {@code -1} if distance is greater than threshold.
      */
     private static int clampDistance(final int distance, final int threshold) {
         return distance > threshold ? -1 : distance;
@@ -47,7 +47,7 @@ private static int clampDistance(final int distance, final int threshold) {
      * @param left      the first SimilarityInput, must not be null.
      * @param right     the second SimilarityInput, must not be null.
      * @param threshold the target threshold, must not be negative.
-     * @return result distance, or -1 if distance exceeds threshold
+     * @return result distance, or -1 if distance exceeds threshold.
      */
     private static <E> int limitedCompare(SimilarityInput<E> left, SimilarityInput<E> right, final int threshold) {
         if (left == null || right == null) {

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

@@ -49,11 +49,10 @@ public class IntersectionResult {
     /**
      * Constructs the results for an intersection between two sets.
      *
-     * @param sizeA the size of set A ({@code |A|}).
-     * @param sizeB the size of set B ({@code |B|}).
+     * @param sizeA        the size of set A ({@code |A|}).
+     * @param sizeB        the size of set B ({@code |B|}).
      * @param intersection the size of the intersection of A and B ({@code |A ∩ B|}).
-     * @throws IllegalArgumentException if the sizes are negative or the intersection is greater
-     * than the minimum of the two set sizes.
+     * @throws IllegalArgumentException if the sizes are negative or the intersection is greater than the minimum of the two set sizes.
      */
     public IntersectionResult(final int sizeA, final int sizeB, final int intersection) {
         if (sizeA < 0) {
@@ -94,7 +93,7 @@ public int getIntersection() {
     /**
      * Gets the size of set A.
      *
-     * @return |A|
+     * @return {@code |A|}
      */
     public int getSizeA() {
         return sizeA;
@@ -103,7 +102,7 @@ public int getSizeA() {
     /**
      * Gets the size of set B.
      *
-     * @return |B|
+     * @return {@code |B|}
      */
     public int getSizeB() {
         return sizeB;

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

@@ -33,11 +33,10 @@ public class JaroWinklerDistance implements EditDistance<Double> {
     /**
      * Computes the Jaro-Winkler string matches, half transpositions, prefix array.
      *
-     * @param first the first string to be matched.
+     * @param first  the first string to be matched.
      * @param second the second string to be matched.
      * @return array containing: matches, half transpositions, and prefix
-     * @deprecated Deprecated as of 1.7. This method will be removed in 2.0, and moved to a Jaro Winkler similarity
-     *             class. TODO see TEXT-104.
+     * @deprecated Deprecated as of 1.7. This method will be removed in 2.0, and moved to a Jaro Winkler similarity class. TODO see TEXT-104.
      */
     @Deprecated
     protected static int[] matches(final CharSequence first, final CharSequence second) {

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

@@ -66,20 +66,16 @@ public class SimilarityScoreFrom<R> {
      * 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,
-     *             but the SimilarityScore#compare(CharSequence left, CharSequence right)
-     *             implementation may not accept nulls.
+     * @param left            This may be null here, but the SimilarityScore#compare(CharSequence left, CharSequence right) implementation may not accept nulls.
      */
     public SimilarityScoreFrom(final SimilarityScore<R> similarityScore, final CharSequence left) {
         Validate.isTrue(similarityScore != null, "The edit distance may not be null.");
-
         this.similarityScore = similarityScore;
         this.left = left;
     }
 
     /**
-     * Compares "left" field against the "right" parameter
-     * using the "similarity score" implementation.
+     * Compares "left" field against the "right" parameter using the "similarity score" implementation.
      *
      * @param right the second CharSequence.
      * @return The similarity score between two CharSequences.