Javadoc

Author: garydgregory

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

@@ -324,7 +324,7 @@ private boolean conditionM0(final String value, final int index) {
     }
 
     /**
-     * Encode a value with Double Metaphone.
+     * Encodes a value with Double Metaphone.
      *
      * @param value String to encode
      * @return an encoded string
@@ -334,7 +334,7 @@ public String doubleMetaphone(final String value) {
     }
 
     /**
-     * Encode a value with Double Metaphone, optionally using the alternate encoding.
+     * Encodes a value with Double Metaphone, optionally using the alternate encoding.
      *
      * @param value String to encode
      * @param alternate use alternate encode
@@ -448,7 +448,7 @@ public String doubleMetaphone(String value, final boolean alternate) {
     }
 
     /**
-     * Encode the value using DoubleMetaphone.  It will only work if
+     * Encodes the value using DoubleMetaphone.  It will only work if
      * {@code obj} is a {@code String} (like {@code Metaphone}).
      *
      * @param obj Object to encode (should be of type String)
@@ -464,7 +464,7 @@ public Object encode(final Object obj) throws EncoderException {
     }
 
     /**
-     * Encode the value using DoubleMetaphone.
+     * Encodes the value using DoubleMetaphone.
      *
      * @param value String to encode
      * @return An encoded String
@@ -475,7 +475,8 @@ public String encode(final String value) {
     }
 
     /**
-     * Returns the maxCodeLen.
+     * Gets the maxCodeLen.
+     *
      * @return int
      */
     public int getMaxCodeLen() {
@@ -988,7 +989,7 @@ private int handleZ(final String value, final DoubleMetaphoneResult result, int
     }
 
     /**
-     * Check if the Double Metaphone values of two {@code String} values
+     * Tests whether the Double Metaphone values of two {@code String} values
      * are equal.
      *
      * @param value1 The left-hand side of the encoded {@link String#equals(Object)}.
@@ -1002,7 +1003,7 @@ public boolean isDoubleMetaphoneEqual(final String value1, final String value2)
     }
 
     /**
-     * Check if the Double Metaphone values of two {@code String} values
+     * Tests whether the Double Metaphone values of two {@code String} values
      * are equal, optionally using the alternate value.
      *
      * @param value1 The left-hand side of the encoded {@link String#equals(Object)}.
@@ -1016,7 +1017,7 @@ public boolean isDoubleMetaphoneEqual(final String value1, final String value2,
     }
 
     /**
-     * Determines whether or not the value starts with a silent letter.  It will
+     * Tests whether or not the value starts with a silent letter.  It will
      * return {@code true} if the value starts with any of 'GN', 'KN',
      * 'PN', 'WR' or 'PS'.
      */
@@ -1032,7 +1033,7 @@ private boolean isSilentStart(final String value) {
     }
 
     /**
-     * Determines whether or not a value is of slavo-germanic origin. A value is
+     * Tests whether or not a value is of slavo-germanic origin. A value is
      * of slavo-germanic origin if it contains any of 'W', 'K', 'CZ', or 'WITZ'.
      */
     private boolean isSlavoGermanic(final String value) {
@@ -1041,14 +1042,15 @@ private boolean isSlavoGermanic(final String value) {
     }
 
     /**
-     * Determines whether or not a character is a vowel or not
+     * Tests whether or not a character is a vowel or not
      */
     private boolean isVowel(final char ch) {
         return VOWELS.indexOf(ch) != -1;
     }
 
     /**
      * Sets the maxCodeLen.
+     *
      * @param maxCodeLen The maxCodeLen to set
      */
     public void setMaxCodeLen(final int maxCodeLen) {