Repository: commons-text Updated Branches: refs/heads/master 93fb453cc -> 9dd58bce9
SANDBOX-488 remove distances from StringMetric javadocs for consistency Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/9dd58bce Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/9dd58bce Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/9dd58bce Branch: refs/heads/master Commit: 9dd58bce9ca43b836ae0a8bd1916daad3f458327 Parents: 93fb453 Author: Bruno P. Kinoshita <[email protected]> Authored: Sat Feb 14 11:21:30 2015 -0200 Committer: Bruno P. Kinoshita <[email protected]> Committed: Sat Feb 14 11:21:30 2015 -0200 ---------------------------------------------------------------------- .../org/apache/commons/text/similarity/StringMetric.java | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/9dd58bce/src/main/java/org/apache/commons/text/similarity/StringMetric.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/text/similarity/StringMetric.java b/src/main/java/org/apache/commons/text/similarity/StringMetric.java index 6c7b9ce..fd6880a 100644 --- a/src/main/java/org/apache/commons/text/similarity/StringMetric.java +++ b/src/main/java/org/apache/commons/text/similarity/StringMetric.java @@ -17,15 +17,14 @@ package org.apache.commons.text.similarity; /** - * Interface for <a - * href='http://en.wikipedia.org/wiki/String_metric'>String Metrics</a>. + * Interface for <a href='http://en.wikipedia.org/wiki/String_metric'>String Metrics</a>. * * <p> - * A string metric measures the distance between two character sequences. The higher the distance, the lesser the - * similarity between the two character sequences. + * A string metric measures the similarity between two character sequences. Depending on + * the algorithm, higher values can mean closer strings, or more distant strings. * </p> * - * @param <R> The type of score used by this StringMetric. + * @param <R> The type of similarity score unit used by this StringMetric. */ public interface StringMetric<R> { @@ -34,7 +33,7 @@ public interface StringMetric<R> { * * @param left the first CharSequence * @param right the second CharSequence - * @return the distance between to two CharSequences + * @return the similarity score between two CharSequences */ R compare(CharSequence left, CharSequence right);
