Completed documentation

Author: tdebatty

src/main/java/info/debatty/java/stringsimilarity/KShingling.java

@@ -94,7 +94,7 @@ public int getK() {
      * 20^k x 4Bytes (sizeof(int))
      * Computation cost is O(n)
      * @param s
-     * @return 
+     * @return the profile of this string as an array of integers
      */
     int[] getArrayProfile(String s) {
         ArrayList<Integer> r = new ArrayList<Integer>(shingles.size());
@@ -137,7 +137,7 @@ private static int[] convertIntegers(List<Integer> integers) {
      * or qgram distance.
      * 
      * @param s
-     * @return 
+     * @return the profile of this string, as a StringProfile object
      */
     public StringProfile getProfile(String s) {
 
@@ -157,7 +157,7 @@ public StringSet getSet(String s) {
     /**
      * Return the number of different n-grams (k-shingles) found by this 
      * k-shingling instance.
-     * @return 
+     * @return the total number of different n-grams found by this k-shingling instance
      */
     public int getDimension() {
         return this.shingles.size();

src/main/java/info/debatty/java/stringsimilarity/LongestCommonSubsequence.java

@@ -45,7 +45,7 @@ public static void main(String[] args) {
      * computed as |s1| + |s2| - 2 * |LCS(s1, s2)|
      * @param s1
      * @param s2
-     * @return 
+     * @return the LCS distance between strings s1 and s2, computed as |s1| + |s2| - 2 * |LCS(s1, s2)|
      */
     public double distance(String s1, String s2) {
         return s1.length() + s2.length() - 2 * length(s1, s2);
@@ -56,7 +56,7 @@ public double distance(String s1, String s2) {
      * and s2.
      * @param s1
      * @param s2
-     * @return 
+     * @return the length of LCS(s1, s2)
      */
     protected int length(String s1, String s2) {
         /* function LCSLength(X[1..m], Y[1..n])