Repository: commons-text Updated Branches: refs/heads/master 0e09bb82a -> a4d880385
TEXT-35 finish javadoc for CosineDistance Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/a4d88038 Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/a4d88038 Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/a4d88038 Branch: refs/heads/master Commit: a4d8803859eb70a032541403c141a43847df8f62 Parents: 0e09bb8 Author: Bruno P. Kinoshita <[email protected]> Authored: Tue Dec 20 11:27:03 2016 +1300 Committer: Bruno P. Kinoshita <[email protected]> Committed: Tue Dec 20 11:27:03 2016 +1300 ---------------------------------------------------------------------- src/changes/changes.xml | 1 + .../apache/commons/text/similarity/CosineDistance.java | 12 +++++++++--- 2 files changed, 10 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/a4d88038/src/changes/changes.xml ---------------------------------------------------------------------- diff --git a/src/changes/changes.xml b/src/changes/changes.xml index cabf16e..4c2f03a 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -22,6 +22,7 @@ <body> <release version="1.0" date="tba" description="tba"> + <action issue="TEXT-35" type="fix" dev="kinow">Unfinished class Javadoc for CosineDistance</action> <action issue="TEXT-33" type="update" dev="chtompki">Consolidating since tags at 1.0, removing deprecated methods</action> <action issue="TEXT-29" type="add" dev="chtompki">Add a builder to StringEscapeUtils</action> <action issue="TEXT-28" type="add" dev="chtompki">Add shell/XSI escape/unescape support</action> http://git-wip-us.apache.org/repos/asf/commons-text/blob/a4d88038/src/main/java/org/apache/commons/text/similarity/CosineDistance.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/text/similarity/CosineDistance.java b/src/main/java/org/apache/commons/text/similarity/CosineDistance.java index 7887063..516c215 100644 --- a/src/main/java/org/apache/commons/text/similarity/CosineDistance.java +++ b/src/main/java/org/apache/commons/text/similarity/CosineDistance.java @@ -21,11 +21,17 @@ import java.util.Map; /** * Measures the cosine distance between two character sequences. * - * <p>It utilizes the CosineSimilarity to compute the distance. Character sequences - * are converted into vectors through a simple tokenizer that works with </p> + * <p>It utilizes the {@link CosineSimilarity} to compute the distance. Character sequences + * are converted into vectors through a simple tokenizer that works with a regular expression + * to split words in a sentence.</p> * - * @since 1.0 + * <p> + * For further explanation about Cosine Similarity and Cosine Distance, refer to + * http://en.wikipedia.org/wiki/Cosine_similarity. + * </p> * + * @since 1.0 + * @see CosineSimilarity */ public class CosineDistance implements EditDistance<Double> { /**
