commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1075400 - /commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/Caverphone.java
Date Mon, 28 Feb 2011 16:06:57 GMT
Author: ggregory
Date: Mon Feb 28 16:06:57 2011
New Revision: 1075400

URL: http://svn.apache.org/viewvc?rev=1075400&view=rev
Log:
Javadoc.

Modified:
    commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/Caverphone.java

Modified: commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/Caverphone.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/Caverphone.java?rev=1075400&r1=1075399&r2=1075400&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/Caverphone.java
(original)
+++ commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/Caverphone.java
Mon Feb 28 16:06:57 2011
@@ -23,7 +23,7 @@ import org.apache.commons.codec.StringEn
 /**
  * Encodes a string into a Caverphone value.
  * 
- * This is an algorithm created the Caversham Project at the University of Otago. It implements
the Caverphone 2.0
+ * This is an algorithm created by the Caversham Project at the University of Otago. It implements
the Caverphone 2.0
  * algorithm:
  * 
  * @author Apache Software Foundation
@@ -42,10 +42,10 @@ public class Caverphone implements Strin
     }
 
     /**
-     * Find the caverphone value of a String. 
+     * Encodes the given String into a Caverphone value.
      *
-     * @param txt String to find the caverphone code for
-     * @return A caverphone code corresponding to the String supplied
+     * @param txt String the source string
+     * @return A caverphone code for the given String
      */
     public String caverphone(String txt) {
         // NOTE: Version 1.0 of Caverphone is easily derivable from this code 



Mime
View raw message