Javadoc.

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

Author: garydgregory

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

@@ -21,7 +21,7 @@
 
 /**
  * Encodes a string into a double metaphone value.
- * This Implementation is based on the algorithm by Lawrence Philips.
+ * This Implementation is based on the algorithm by <CITE>Lawrence Philips</CITE>.
  * <ul>
  * <li>Original Article: <a 
  * href="http://www.cuj.com/documents/s=8038/cuj0006philips/">
@@ -31,7 +31,7 @@
  * </ul>
  * 
  * @author Apache Software Foundation
- * @version $Id: DoubleMetaphone.java,v 1.23 2004/05/24 04:55:33 ggregory Exp $
+ * @version $Id: DoubleMetaphone.java,v 1.24 2004/06/05 18:32:04 ggregory Exp $
  */
 public class DoubleMetaphone implements StringEncoder {
 

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

@@ -20,15 +20,18 @@
 import org.apache.commons.codec.StringEncoder;
 
 /**
- * Encodes a string into a metaphone value.
- * The initial Java implementation, William B. Brogden.  December, 1997
- * Permission given by wbrogden for code to be used anywhere.
- * 
- *  "Hanging on the Metaphone" by Lawrence Philips
- *      <i>Computer Language</i> of Dec. 1990, p 39   
+ * Encodes a string into a metaphone value. 
+ * <p>
+ * Initial Java implementation by <CITE>William B. Brogden. December, 1997</CITE>. 
+ * Permission given by <CITE>wbrogden</CITE> for code to be used anywhere.
+ * </p>
+ * <p>
+ * <CITE>Hanging on the Metaphone</CITE> by <CITE>Lawrence Philips</CITE> in <CITE>Computer Language of Dec. 1990, p
+ * 39.</CITE>
+ * </p>
  * 
  * @author Apache Software Foundation
- * @version $Id: Metaphone.java,v 1.19 2004/05/24 04:56:29 ggregory Exp $
+ * @version $Id: Metaphone.java,v 1.20 2004/06/05 18:32:04 ggregory Exp $
  */
 public class Metaphone implements StringEncoder {
 

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

@@ -20,12 +20,12 @@
 import org.apache.commons.codec.StringEncoder;
 
 /**
- * Encodes a string into a refined soundex value. A refined soundex code is
- * optimized for spell checking word. "Soundex" method originally developed by
- * Margaret Odell and Robert Russell
+ * Encodes a string into a Refined Soundex value. A refined soundex code is
+ * optimized for spell checking words. Soundex method originally developed by
+ * <CITE>Margaret Odell</CITE> and <CITE>Robert Russell</CITE>.
  * 
  * @author Apache Software Foundation
- * @version $Id: RefinedSoundex.java,v 1.20 2004/05/24 04:57:24 ggregory Exp $
+ * @version $Id: RefinedSoundex.java,v 1.21 2004/06/05 18:32:04 ggregory Exp $
  */
 public class RefinedSoundex implements StringEncoder {
 

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

@@ -20,11 +20,11 @@
 import org.apache.commons.codec.StringEncoder;
 
 /**
- * Encodes a string into a soundex value. Soundex is an encoding used to relate similar names, but can also be used as a
+ * Encodes a string into a Soundex value. Soundex is an encoding used to relate similar names, but can also be used as a
  * general purpose scheme to find word with similar phonemes.
  * 
  * @author Apache Software Foundation
- * @version $Id: Soundex.java,v 1.23 2004/06/05 00:43:32 ggregory Exp $
+ * @version $Id: Soundex.java,v 1.24 2004/06/05 18:32:04 ggregory Exp $
  */
 public class Soundex implements StringEncoder {
 
@@ -35,13 +35,25 @@ public class Soundex implements StringEncoder {
      */
     public static final Soundex US_ENGLISH = new Soundex();
 
+    /**
+     * This is a default mapping of the 26 letters used in US English. A value of <code>0</code> for a letter position
+     * means do not encode.
+     * <p>
+     * (This constant is provided as both an implementation convenience and to allow Javadoc to pick
+     * up the value for the constant values page.)
+     * </p>
+     * 
+     * @see #US_ENGLISH_MAPPING
+     */
+    public static final String US_ENGLISH_MAPPING_STRING = "01230120022455012623010202";
+
     /**
      * This is a default mapping of the 26 letters used in US English. A value of <code>0</code> for a letter position
      * means do not encode.
      * 
      * @see Soundex#Soundex(char[])
      */
-    public static final char[] US_ENGLISH_MAPPING = "01230120022455012623010202".toCharArray();
+    public static final char[] US_ENGLISH_MAPPING = US_ENGLISH_MAPPING_STRING.toCharArray();
 
     /**
      * Encodes the Strings and returns the number of characters in the two encoded Strings that are the same. This
@@ -90,8 +102,8 @@ public Soundex() {
     }
 
     /**
-     * Creates a soundex instance using the given mapping. This constructor can be used to customize the mapping, and/or
-     * possibly provide an internationalized mapping for a non-Western character set.
+     * Creates a soundex instance using the given mapping. This constructor can be used to provide an internationalized
+     * mapping for a non-Western character set.
      * 
      * Every letter of the alphabet is "mapped" to a numerical value. This char array holds the values to which each
      * letter is mapped. This implementation contains a default map for US_ENGLISH