2424 * Encodes a string into a Soundex value. Soundex is an encoding used to relate similar names, but can also be used as a
2525 * general purpose scheme to find word with similar phonemes.
2626 *
27- * This class is thread-safe.
28- * Although not strictly immutable, the {@link #maxLength} field is not actually used.
29- *
27+ * <p>This class is thread-safe.
28+ * Although not strictly immutable, the mutable fields are not actually used.</p>
3029 */
3130public class Soundex implements StringEncoder {
3231
@@ -53,7 +52,6 @@ public class Soundex implements StringEncoder {
5352 * <b>Note that letters H and W are treated specially.</b>
5453 * They are ignored (after the first letter) and don't act as separators
5554 * between consonants with the same code.
56- * @see #US_ENGLISH_MAPPING
5755 */
5856 // ABCDEFGHIJKLMNOPQRSTUVWXYZ
5957 public static final String US_ENGLISH_MAPPING_STRING = "01230120022455012623010202" ;
@@ -72,7 +70,6 @@ public class Soundex implements StringEncoder {
7270 * Apart from when they appear as the first letter, they are ignored.
7371 * They don't act as separators between duplicate codes.
7472 *
75- * @see #US_ENGLISH_MAPPING
7673 * @see #US_ENGLISH_MAPPING_STRING
7774 */
7875 public static final Soundex US_ENGLISH = new Soundex ();
@@ -133,7 +130,7 @@ public class Soundex implements StringEncoder {
133130 * Creates an instance using US_ENGLISH_MAPPING
134131 *
135132 * @see Soundex#Soundex(char[])
136- * @see Soundex#US_ENGLISH_MAPPING
133+ * @see Soundex#US_ENGLISH_MAPPING_STRING
137134 */
138135 public Soundex () {
139136 this .soundexMapping = US_ENGLISH_MAPPING ;
0 commit comments