commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brit...@apache.org
Subject [5/8] [text] Better JavaDoc for JaroWinklerDistance
Date Sun, 14 Dec 2014 20:41:24 GMT
Better JavaDoc for JaroWinklerDistance


Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/1d596297
Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/1d596297
Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/1d596297

Branch: refs/heads/master
Commit: 1d5962978f0a863a2455d6a34b26aa565845c6c7
Parents: 5fce7f8
Author: Benedikt Ritter <britter@apache.org>
Authored: Sun Dec 14 21:31:46 2014 +0100
Committer: Benedikt Ritter <britter@apache.org>
Committed: Sun Dec 14 21:31:46 2014 +0100

----------------------------------------------------------------------
 .../commons/text/similarity/JaroWrinklerDistance.java     | 10 +++-------
 1 file changed, 3 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-text/blob/1d596297/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java b/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java
index 9915caf..3633d41 100644
--- a/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java
@@ -17,6 +17,8 @@
 package org.apache.commons.text.similarity;
 
 /**
+ * A similarity algorithm indicating the percentage of matched characters between two character
sequences.
+ *
  * <p>
  * The Jaro measure is the weighted sum of percentage of matched characters
  * from each file and transposed characters. Winkler increased this measure
@@ -41,10 +43,8 @@ public class JaroWrinklerDistance implements StringMetric<Double>
{
     public static final int INDEX_NOT_FOUND = -1;
 
     /**
-     * <p>
      * Find the Jaro Winkler Distance which indicates the similarity score
-     * between two Strings.
-     * </p>
+     * between two CharSequences.
      *
      * <pre>
      * distance.getJaroWinklerDistance(null, null)          = IllegalArgumentException
@@ -102,10 +102,8 @@ public class JaroWrinklerDistance implements StringMetric<Double>
{
     }
 
     /**
-     * <p>
      * Compares all Strings in an array and returns the initial sequence of
      * characters that is common to all of them.
-     * </p>
      *
      * <p>
      * For example,
@@ -232,10 +230,8 @@ public class JaroWrinklerDistance implements StringMetric<Double>
{
     }
 
     /**
-     * <p>
      * Compares all CharSequences in an array and returns the index at which the
      * CharSequences begin to differ.
-     * </p>
      *
      * <p>
      * For example,


Mime
View raw message