/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.text.similarity;

/**
 * <p>
 * Marker interface for <a
 * href='http://en.wikipedia.org/wiki/String_metric'>String Metrics</a>
 * </p>
 *
 * <p>
 * A string metric measures the distance between two text strings.
 * </p>
 *
 * @param <R> return type of the edit distance
 */
public interface StringMetric<R> {

    /**
     * <p>
     * Compares two strings.
     * </p>
     *
     * @param left the first string
     * @param right the second string
     * @return result distance
     */
    R compare(CharSequence left, CharSequence right);

}

@@ -852,23 +852,9 @@
 %0A * 
-%3Cp%3E%0A * Marker i
+I
 nter
@@ -936,24 +936,17 @@
 rics%3C/a%3E
-%0A * %3C/p%3E
+.
 %0A *%0A * %3C
@@ -1005,19 +1005,117 @@
 two 
-text string
+character sequences. The higher the distance, the lesser the%0A * similarity between the two character sequence
 s.%0A 
@@ -1138,22 +1138,19 @@
 ram %3CR%3E 
-return
+The
  type of
@@ -1154,25 +1154,40 @@
  of 
-the edit distance
+score used by this StringMetric.
 %0A */
@@ -1235,19 +1235,8 @@
 /**%0A
-     * %3Cp%3E%0A
     
@@ -1255,28 +1255,22 @@
 two 
-strings.%0A     * %3C/p%3E
+CharSequences.
 %0A   
@@ -1302,22 +1302,28 @@
 e first 
-string
+CharSequence
 %0A     * 
@@ -1346,22 +1346,28 @@
  second 
-string
+CharSequence
 %0A     * 
@@ -1378,14 +1378,11 @@
 urn 
-result
+the
  dis
@@ -1386,16 +1386,45 @@
 distance
+ between to two CharSequences
 %0A     */

Clarify wording in StringMetric interface