Fix Javadoc nits.

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

Author: garydgregory

src/java/org/apache/commons/codec/StringEncoderComparator.java

@@ -63,14 +63,14 @@
  * String are comparable, and this comparator allows 
  * you to configure it with an instance of a class
  * which implements the StringEncoder.  This comparator
- * is used to sort Strings by an encoding shceme such
+ * is used to sort Strings by an encoding scheme such
  * as Soundex, Metaphone, etc.  This class can come in
  * handy if one need to sort Strings by an encoded
  * form of a name such as Soundex.
  *
  * @author Tim O'Brien
  * @author Gary Gregory
- * @version $Id: StringEncoderComparator.java,v 1.9 2003/11/13 06:50:35 ggregory Exp $
+ * @version $Id: StringEncoderComparator.java,v 1.10 2003/11/24 00:11:56 ggregory Exp $
  */
 public class StringEncoderComparator implements Comparator {
 
@@ -87,10 +87,11 @@ public StringEncoderComparator() {
     }
 
     /**
-     * Constructs a new instance with the given soundex algorithm.
+     * Constructs a new instance with the given algorithm.
+     * @param stringEncoder the StringEncoder used for comparisons.
      */
-    public StringEncoderComparator(StringEncoder en) {
-        this.stringEncoder = en;
+    public StringEncoderComparator(StringEncoder stringEncoder) {
+        this.stringEncoder = stringEncoder;
     }
 
     /**
@@ -101,6 +102,9 @@ public StringEncoderComparator(StringEncoder en) {
      * 
      * If an {@link EncoderException} is encountered, return <code>0</code>.
      * 
+     * @param o1 the object to compare
+     * @param o2 the object to compare to
+     * @return the Comparable.compareTo() return code or 0 if an encoding error was caught.
      * @see Comparable
      */
     public int compare(Object o1, Object o2) {

src/java/org/apache/commons/codec/binary/Base64.java

@@ -73,7 +73,7 @@
   * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
   * @author Tim O'Brien
   * @since 1.0-dev
-  * @version $Id: Base64.java,v 1.13 2003/11/06 16:32:30 ggregory Exp $
+  * @version $Id: Base64.java,v 1.14 2003/11/24 00:11:56 ggregory Exp $
   */
 public class Base64 implements BinaryEncoder, BinaryDecoder {
 
@@ -258,8 +258,6 @@ public Object decode(Object pObject) throws DecoderException {
      *
      * @param pArray A byte array containing Base64 character data
      * @return a byte array containing binary data
-     * @throws DecoderException if there is an Decoder specific exception
-     *                          during the decoding process
      */
     public byte[] decode(byte[] pArray) {
         byte[] result;
@@ -569,8 +567,6 @@ public Object encode(Object pObject) throws EncoderException {
      *
      * @param pArray a byte array containing binary data
      * @return A byte array containing only Base64 character data
-     * @throws EncoderException if there is an Encoder specific exception
-     *                          during the encoding process
      */
     public byte[] encode(byte[] pArray) {
         return (encodeBase64(pArray, false));

src/java/org/apache/commons/codec/digest/DigestUtils.java

@@ -75,6 +75,7 @@ public class DigestUtils {
     /**
      * Returns a MessageDigest for the given <code>algorithm</code>.
      *
+     * @param algorithm The MessageDigest algorithm name.
      * @return An MD5 digest instance.
      * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught,
      */

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

@@ -73,7 +73,7 @@
  * 
  * @author <a href="mailto:ben@walstrum.com">Benjamin Walstrum</a>
  * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
- * @version $Id: DoubleMetaphone.java,v 1.14 2003/11/07 23:12:54 ggregory Exp $
+ * @version $Id: DoubleMetaphone.java,v 1.15 2003/11/24 00:11:56 ggregory Exp $
  */
 public class DoubleMetaphone implements StringEncoder {
 
@@ -252,11 +252,9 @@ public Object encode(Object obj) throws EncoderException {
      *
      * @param value String to encode
      * @return An encoded String
-     * @throws EncoderException thrown if there is an exception during
-     *         the encoding process.
      */
     public String encode(String value) {
-        return (doubleMetaphone(value));   
+        return doubleMetaphone(value);   
     }
 
     /**

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

@@ -72,7 +72,7 @@
  * @author bayard@generationjava.com
  * @author Tim O'Brien
  * @author Gary Gregory
- * @version $Id: Metaphone.java,v 1.10 2003/11/07 23:12:54 ggregory Exp $
+ * @version $Id: Metaphone.java,v 1.11 2003/11/24 00:11:56 ggregory Exp $
  */
 public class Metaphone implements StringEncoder {
 
@@ -373,11 +373,9 @@ public Object encode(Object pObject) throws EncoderException {
      *
      * @param pString String object to encode
      * @return The metaphone code corresponding to the String supplied
-     * @throws EncoderException thrown if a Metaphone specific exception
-     *                          is encountered.
      */
     public String encode(String pString) {
-        return (metaphone(pString));   
+        return metaphone(pString);   
     }
 
     /**

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

@@ -68,7 +68,7 @@
  * 
  * @author Tim O'Brien
  * @author ggregory@seagullsw.com
- * @version $Id: RefinedSoundex.java,v 1.11 2003/11/07 22:39:30 ggregory Exp $
+ * @version $Id: RefinedSoundex.java,v 1.12 2003/11/24 00:11:56 ggregory Exp $
  */
 public class RefinedSoundex implements StringEncoder {
 
@@ -154,11 +154,9 @@ public String soundex(String str) {
      *
      * @param pString A String object to encode
      * @return A Soundex code corresponding to the String supplied
-     * @throws EncoderException throws exception if there is an
-     *                          encoding-specific problem
      */
     public String encode(String pString) {
-        return (soundex(pString));   
+        return soundex(pString);   
     }
 
     /**

src/java/org/apache/commons/codec/net/URLCodec.java

@@ -87,7 +87,7 @@
  * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
  * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
  * @since 1.2
- * @version $Id: URLCodec.java,v 1.10 2003/11/08 01:52:25 ggregory Exp $
+ * @version $Id: URLCodec.java,v 1.11 2003/11/24 00:11:56 ggregory Exp $
  */
 
 public class URLCodec 
@@ -137,6 +137,8 @@ public URLCodec() {
 
     /**
      * Constructor which allows for the selection of an Encoding
+     * 
+     * @param encoding the String encoding to use.
      */
     public URLCodec(String encoding) {
         super();
@@ -249,20 +251,21 @@ public byte[] decode(byte[] pArray) throws DecoderException {
 
     /**
      * Encodes a string into its URL safe form using the specified
-     * character set. Unsafe characters are escaped.
+     * encoding. Unsafe characters are escaped.
      *
      * @param pString string to convert to a URL safe form
+     * @param encoding the encoding for pString
      * @return URL safe string
      * @throws UnsupportedEncodingException Thrown if charset is not
      *                                      supported 
      */
-    public String encode(String pString, String charset) 
+    public String encode(String pString, String encoding) 
         throws UnsupportedEncodingException  
     {
         if (pString == null) {
             return null;
         }
-        return new String(encode(pString.getBytes(charset)), this.getEncoding());
+        return new String(encode(pString.getBytes(encoding)), this.getEncoding());
     }
 
 
@@ -288,22 +291,23 @@ public String encode(String pString) throws EncoderException {
 
     /**
      * Decodes a URL safe string into its original form using the 
-     * specified character set. Escaped characters are converted back 
+     * specified encoding. Escaped characters are converted back 
      * to their original representation.
      *
      * @param pString URL safe string to convert into its original form
+     * @param encoding the original string encoding
      * @return original string 
      * @throws DecoderException Thrown if URL decoding is unsuccessful
      * @throws UnsupportedEncodingException Thrown if charset is not
      *                                      supported 
      */
-    public String decode(String pString, String charset) 
+    public String decode(String pString, String encoding) 
         throws DecoderException, UnsupportedEncodingException 
     {
         if (pString == null) {
             return null;
         }
-        return new String(decode(pString.getBytes(this.getEncoding())), charset);
+        return new String(decode(pString.getBytes(this.getEncoding())), encoding);
     }