ggregory 2003/12/09 18:51:26
Modified: codec/src/java/org/apache/commons/codec/language
Soundex.java
Log:
Slightly better javadocs for the difference() APIs.
Revision Changes Path
1.15 +10 -10
jakarta-commons/codec/src/java/org/apache/commons/codec/language/Soundex.java
Index: Soundex.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/codec/src/java/org/apache/commons/codec/language/Soundex.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Soundex.java 10 Dec 2003 00:04:46 -0000 1.14
+++ Soundex.java 10 Dec 2003 02:51:26 -0000 1.15
@@ -76,10 +76,10 @@
* Soundex, this return value ranges from 0 through 4: 0 indicates little or
* no similarity, and 4 indicates strong similarity or identical values.
*
- * @param s1
- * A String.
- * @param s2
- * A String.
+ * @param s1
+ * A String that will be encoded and compared.
+ * @param s2
+ * A String that will be encoded and compared.
* @return The return value ranges from 0 through 4: 0 indicates little or
* no similarity, and 4 indicates strong similarity or identical
* values.
@@ -102,11 +102,11 @@
* similarity, and 4 indicates strong similarity or identical values.
*
* @param encoder
- * The encoder to use to encode the String parameters with.
- * @param s1
- * A String.
- * @param s2
- * A String.
+ * The encoder to use to encode the String parameters.
+ * @param s1
+ * A String that will be encoded and compared.
+ * @param s2
+ * A String that will be encoded and compared.
* @return an integer from 0 to the length of the shorter string. The
* smaller the number, the more different the strings are.
*
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
