Javadoc

Author: garydgregory

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

@@ -24,7 +24,7 @@
 import org.apache.commons.codec.binary.StringUtils;
 
 /**
- * Encodes a string into a double metaphone value. This Implementation is based on the algorithm by <CITE>Lawrence
+ * Encodes a string into a Double Metaphone value. This Implementation is based on the algorithm by <CITE>Lawrence
  * Philips</CITE>.
  * <p>
  * This class is conditionally thread-safe. The instance field for the maximum code length is mutable

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

@@ -57,22 +57,22 @@
 public class Metaphone implements StringEncoder {
 
     /**
-     * Five values in the English language
+     * Five values in the English language.
      */
     private static final String VOWELS = "AEIOU";
 
     /**
-     * Variable used in Metaphone algorithm
+     * Variable used in Metaphone algorithm.
      */
     private static final String FRONTV = "EIY";
 
     /**
-     * Variable used in Metaphone algorithm
+     * Variable used in Metaphone algorithm.
      */
     private static final String VARSON = "CSPTG";
 
     /**
-     * The max code length for metaphone is 4
+     * The max code length for Metaphone is 4.
      */
     private int maxCodeLen = 4;
 
@@ -84,11 +84,11 @@ public Metaphone() {
     }
 
     /**
-     * Encodes an Object using the metaphone algorithm. This method is provided in order to satisfy the requirements of the Encoder interface, and will throw an
+     * Encodes an Object using the Metaphone algorithm. This method is provided in order to satisfy the requirements of the Encoder interface, and will throw an
      * EncoderException if the supplied object is not of type {@link String}.
      *
      * @param obj Object to encode.
-     * @return An object (or type {@link String}) containing the metaphone code which corresponds to the String supplied.
+     * @return An object (or type {@link String}) containing the Metaphone code which corresponds to the String supplied.
      * @throws EncoderException if the parameter supplied is not of type {@link String}.
      */
     @Override
@@ -103,7 +103,7 @@ public Object encode(final Object obj) throws EncoderException {
      * Encodes a String using the Metaphone algorithm.
      *
      * @param str String object to encode
-     * @return The metaphone code corresponding to the String supplied
+     * @return The Metaphone code corresponding to the String supplied
      */
     @Override
     public String encode(final String str) {
@@ -124,11 +124,11 @@ private boolean isLastChar(final int wdsz, final int n) {
     }
 
     /**
-     * Tests is the metaphones of two strings are identical.
+     * Tests is the Metaphones of two strings are identical.
      *
      * @param str1 First of two strings to compare.
      * @param str2 Second of two strings to compare.
-     * @return {@code true} if the metaphones of these strings are identical, {@code false} otherwise.
+     * @return {@code true} if the Metaphones of these strings are identical, {@code false} otherwise.
      */
     public boolean isMetaphoneEqual(final String str1, final String str2) {
         return metaphone(str1).equals(metaphone(str2));
@@ -155,14 +155,14 @@ private boolean isVowel(final StringBuilder string, final int index) {
     }
 
     /**
-     * Find the metaphone value of a String. This is similar to the
+     * Find the Metaphone value of a String. This is similar to the
      * Soundex algorithm, but better at finding similar sounding words.
      * All input is converted to upper case.
      * Limitations: Input format is expected to be a single ASCII word
      * with only characters in the A - Z range, no punctuation or numbers.
      *
-     * @param txt String to find the metaphone code for.
-     * @return A metaphone code corresponding to the String supplied.
+     * @param txt String to find the Metaphone code for.
+     * @return A Metaphone code corresponding to the String supplied.
      */
     public String metaphone(final String txt) {
         boolean hard = false;

src/test/java/org/apache/commons/codec/language/MetaphoneTest.java

@@ -287,11 +287,11 @@ void testTranslateToJOfDGEOrDGIOrDGY() {
     }
 
     /**
-     * Tests (CODEC-57) Metaphone.metaphone(String) returns an empty string when passed the word "why"
+     * Tests (CODEC-57) Metaphone.Metaphone(String) returns an empty string when passed the word "why"
      */
     @Test
     void testWhy() {
-        // PHP returns "H". The original metaphone returns an empty string.
+        // PHP returns "H". The original Metaphone returns an empty string.
         assertEquals("", getStringEncoder().metaphone("WHY"));
     }