Better Javadoc

Author: garydgregory

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

@@ -35,14 +35,14 @@ public abstract class AbstractCaverphone implements StringEncoder {
 
     /**
      * Encodes an Object using the caverphone 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 java.lang.String.
+     * the Encoder interface, and will throw an EncoderException if the supplied object is not of type {@link String}.
      *
      * @param source
      *            Object to encode
-     * @return An object (or type java.lang.String) containing the caverphone code which corresponds to the String
+     * @return An object (or type {@link String}) containing the caverphone code which corresponds to the String
      *         supplied.
      * @throws EncoderException
-     *             if the parameter supplied is not of type java.lang.String
+     *             if the parameter supplied is not of type {@link String}.
      */
     @Override
     public Object encode(final Object source) throws EncoderException {

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

@@ -52,14 +52,14 @@ public String caverphone(final String source) {
 
     /**
      * Encodes an Object using the caverphone 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 java.lang.String.
+     * 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 java.lang.String) containing the caverphone code which corresponds to the String
+     * @return An object (or type {@link String}) containing the caverphone code which corresponds to the String
      *         supplied.
      * @throws EncoderException
-     *             if the parameter supplied is not of type java.lang.String
+     *             if the parameter supplied is not of type {@link String}.
      */
     @Override
     public Object encode(final Object obj) throws EncoderException {

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

@@ -375,17 +375,17 @@ private String cleanup(final String input) {
      * Encodes an Object using the Daitch-Mokotoff soundex algorithm without branching.
      * <p>
      * 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 java.lang.String.
+     * EncoderException if the supplied object is not of type {@link String}.
      * </p>
      *
      * @see #soundex(String)
      *
      * @param obj
      *            Object to encode
-     * @return An object (of type java.lang.String) containing the DM soundex code, which corresponds to the String
+     * @return An object (of type {@link String}) containing the DM soundex code, which corresponds to the String
      *         supplied.
      * @throws EncoderException
-     *             if the parameter supplied is not of type java.lang.String
+     *             if the parameter supplied is not of type {@link String}
      * @throws IllegalArgumentException
      *             if a character is not mapped
      */

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

@@ -91,14 +91,14 @@ String cleanName(final String name) {
 
     /**
      * Encodes an Object using the Match Rating Approach algorithm. Method is here to satisfy the requirements of the
-     * Encoder interface Throws an EncoderException if input object is not of type java.lang.String.
+     * Encoder interface Throws an EncoderException if input object is not of type {@link String}.
      *
      * @param pObject
      *            Object to encode
-     * @return An object (or type java.lang.String) containing the Match Rating Approach code which corresponds to the
+     * @return An object (or type {@link String}) containing the Match Rating Approach code which corresponds to the
      *         String supplied.
      * @throws EncoderException
-     *             if the parameter supplied is not of type java.lang.String
+     *             if the parameter supplied is not of type {@link String}
      */
     @Override
     public final Object encode(final Object pObject) throws EncoderException {

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

@@ -78,13 +78,13 @@ public class Metaphone implements StringEncoder {
      * 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 java.lang.String.
+     * supplied object is not of type {@link String}.
      *
      * @param obj Object to encode
-     * @return An object (or type java.lang.String) containing the
+     * @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 java.lang.String
+     *                          of type {@link String}
      */
     @Override
     public Object encode(final Object obj) throws EncoderException {

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

@@ -131,14 +131,14 @@ public int difference(final String s1, final String s2) throws EncoderException
      * Encodes an Object using the refined soundex 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
-     * java.lang.String.
+     * {@link String}.
      *
      * @param obj
      *                  Object to encode
-     * @return An object (or type java.lang.String) containing the refined
+     * @return An object (or type {@link String}) containing the refined
      *             soundex code which corresponds to the String supplied.
      * @throws EncoderException
-     *                  if the parameter supplied is not of type java.lang.String
+     *                  if the parameter supplied is not of type {@link String}
      */
     @Override
     public Object encode(final Object obj) throws EncoderException {

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

@@ -219,14 +219,14 @@ public int difference(final String s1, final String s2) throws EncoderException
 
     /**
      * Encodes an Object using the soundex 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 java.lang.String.
+     * 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 java.lang.String) containing the soundex code which corresponds to the String
+     * @return An object (or type {@link String}) containing the soundex code which corresponds to the String
      *             supplied.
      * @throws EncoderException
-     *                  if the parameter supplied is not of type java.lang.String
+     *                  if the parameter supplied is not of type {@link String}
      * @throws IllegalArgumentException
      *                  if a character is not mapped
      */