Add missing Javadoc tags on public methods. Compiler warnings WRT unqualified instance variable access (added "this.").

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/codec/trunk@130264 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

src/java/org/apache/commons/codec/language/DoubleMetaphone.java

@@ -73,7 +73,7 @@
  * 
  * @author <a href="mailto:ben@walstrum.com">Benjamin Walstrum</a>
  * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
- * @version $Id: DoubleMetaphone.java,v 1.15 2003/11/24 00:11:56 ggregory Exp $
+ * @version $Id: DoubleMetaphone.java,v 1.16 2003/12/04 17:43:04 ggregory Exp $
  */
 public class DoubleMetaphone implements StringEncoder {
 
@@ -237,11 +237,12 @@ public String doubleMetaphone(String value, boolean alternate) {
      *
      * @param obj Object to encode (should be of type String)
      * @return An encoded Object (will be of type String)
+     * @throws EncoderException encode parameter is not of type String
      */
     public Object encode(Object obj) throws EncoderException {
 
         if (!(obj instanceof String)) {
-            throw new EncoderException("DoubleMetaphone encode parameter is not of type java.lang.String"); 
+            throw new EncoderException("DoubleMetaphone encode parameter is not of type String"); 
         } else {
             return doubleMetaphone((String) obj);
         }
@@ -259,15 +260,27 @@ public String encode(String value) {
 
     /**
      * Check if the Double Metaphone values of two <code>String</code> values
-     * are equal
+     * are equal.
+     * 
+     * @param value1 The left-hand side of the encoded {@link String#equals(Object)}.
+     * @param value2 The right-hand side of the encoded {@link String#equals(Object)}.
+     * @return <code>true</code> if the encoded <code>String</code>s are equal;
+     *          <code>false</code> otherwise.
+     * @see #isDoubleMetaphoneEqual(String,String,boolean)
      */
     public boolean isDoubleMetaphoneEqual(String value1, String value2) {
         return isDoubleMetaphoneEqual(value1, value2, false);
     }
 
     /**
      * Check if the Double Metaphone values of two <code>String</code> values
-     * are equal, optionally using the alternate value
+     * are equal, optionally using the alternate value.
+     * 
+     * @param value1 The left-hand side of the encoded {@link String#equals(Object)}.
+     * @param value2 The right-hand side of the encoded {@link String#equals(Object)}.
+     * @param alternate use the alternate value if <code>true</code>.
+     * @return <code>true</code> if the encoded <code>String</code>s are equal;
+     *          <code>false</code> otherwise.
      */
     public boolean isDoubleMetaphoneEqual(String value1, 
                                           String value2, 

src/java/org/apache/commons/codec/language/Metaphone.java

@@ -72,7 +72,7 @@
  * @author bayard@generationjava.com
  * @author Tim O'Brien
  * @author Gary Gregory
- * @version $Id: Metaphone.java,v 1.11 2003/11/24 00:11:56 ggregory Exp $
+ * @version $Id: Metaphone.java,v 1.12 2003/12/04 17:43:04 ggregory Exp $
  */
 public class Metaphone implements StringEncoder {
 
@@ -193,14 +193,14 @@ public String metaphone(String txt) {
                     break;
                 case 'C' : // lots of C special cases
                     /* discard if SCI, SCE or SCY */
-                    if ((n > 0) && (local.charAt(n - 1) == 'S') && (n + 1 < wdsz) && (frontv.indexOf(local.charAt(n + 1)) >= 0)) { 
+                    if ((n > 0) && (local.charAt(n - 1) == 'S') && (n + 1 < wdsz) && (this.frontv.indexOf(local.charAt(n + 1)) >= 0)) { 
                         break ;
                     }
                     tmpS = local.toString();
                     if (tmpS.indexOf("CIA", n) == n) { // "CIA" -> X
                         code.append('X'); mtsz++; break ;
                     }
-                    if ((n + 1 < wdsz) && (frontv.indexOf(local.charAt(n + 1)) >= 0)) {
+                    if ((n + 1 < wdsz) && (this.frontv.indexOf(local.charAt(n + 1)) >= 0)) {
                         code.append('S');
                         mtsz++; 
                         break ; // CI,CE,CY -> S
@@ -211,7 +211,7 @@ public String metaphone(String txt) {
                         break ;
                     }
                     if (tmpS.indexOf("CH", n) == n) { // detect CH
-                        if ((n == 0) && (wdsz >= 3) && (vowels.indexOf(local.charAt(2)) < 0)) { // CH consonant -> K consonant
+                        if ((n == 0) && (wdsz >= 3) && (this.vowels.indexOf(local.charAt(2)) < 0)) { // CH consonant -> K consonant
                             code.append('K');
                         } else { 
                             code.append('X'); // CHvowel -> X
@@ -223,7 +223,7 @@ public String metaphone(String txt) {
                     }
                     break ;
                 case 'D' :
-                    if ((n + 2 < wdsz)   && (local.charAt(n + 1) == 'G') && (frontv.indexOf(local.charAt(n + 2)) >= 0)) { // DGE DGI DGY -> J 
+                    if ((n + 2 < wdsz)   && (local.charAt(n + 1) == 'G') && (this.frontv.indexOf(local.charAt(n + 2)) >= 0)) { // DGE DGI DGY -> J 
                         code.append('J'); n += 2 ;
                     } else { 
                         code.append('T');
@@ -234,7 +234,7 @@ public String metaphone(String txt) {
                     if ((n + 2 == wdsz) && (local.charAt(n + 1) == 'H')) {
                         break;
                     }
-                    if ((n + 2 < wdsz) && (local.charAt(n + 1) == 'H') && (vowels.indexOf(local.charAt(n + 2)) < 0)) {
+                    if ((n + 2 < wdsz) && (local.charAt(n + 1) == 'H') && (this.vowels.indexOf(local.charAt(n + 2)) < 0)) {
                         break;
                     }
                     tmpS = local.toString();
@@ -246,7 +246,7 @@ public String metaphone(String txt) {
                     } else {
                         hard = false ;
                     }
-                    if ((n + 1 < wdsz) && (frontv.indexOf(local.charAt(n + 1)) >= 0) && (!hard)) {
+                    if ((n + 1 < wdsz) && (this.frontv.indexOf(local.charAt(n + 1)) >= 0) && (!hard)) {
                         code.append('J');
                     } else {
                         code.append('K');
@@ -257,10 +257,10 @@ public String metaphone(String txt) {
                     if (n + 1 == wdsz) {
                         break ; // terminal H
                     }
-                    if ((n > 0) && (varson.indexOf(local.charAt(n - 1)) >= 0)) {
+                    if ((n > 0) && (this.varson.indexOf(local.charAt(n - 1)) >= 0)) {
                         break;
                     }
-                    if (vowels.indexOf(local.charAt(n + 1)) >= 0) {
+                    if (this.vowels.indexOf(local.charAt(n + 1)) >= 0) {
                         code.append('H'); 
                         mtsz++;// Hvowel
                     }
@@ -327,7 +327,7 @@ public String metaphone(String txt) {
                 case 'V' :
                     code.append('F'); mtsz++;break ;
                 case 'W' : case 'Y' : // silent if not followed by vowel
-                    if ((n + 1 < wdsz) && (vowels.indexOf(local.charAt(n + 1)) >= 0)) {
+                    if ((n + 1 < wdsz) && (this.vowels.indexOf(local.charAt(n + 1)) >= 0)) {
                         code.append(symb);
                         mtsz++;
                     }