Javadoc.

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

Author: garydgregory

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

@@ -18,7 +18,8 @@
 package org.apache.commons.codec;
 
 /**
- * Thrown when a Decoder has encountered a failure condition during a decode.
+ * Thrown when there is a failure condition during the decoding process. This exception is thrown when a {@link Decoder}
+ * encounters a decoding specific exception such as invalid data, or characters outside of the expected range.
  * 
  * @author Apache Software Foundation
  * @version $Id$

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

@@ -18,9 +18,9 @@
 package org.apache.commons.codec;
 
 /**
- * Thrown when there is a failure condition during the encoding process. This exception is thrown when an Encoder
- * encounters a encoding specific exception such as invalid data, inability to calculate a checksum, characters outside
- * of the expected range.
+ * Thrown when there is a failure condition during the encoding process. This exception is thrown when an
+ * {@link Encoder} encounters a encoding specific exception such as invalid data, inability to calculate a checksum,
+ * characters outside of the expected range.
  * 
  * @author Apache Software Foundation
  * @version $Id$

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

@@ -18,7 +18,7 @@
 package org.apache.commons.codec;
 
 /**
- * Decodes a String into a String. 
+ * Defines common decoding methods for String decoders.
  *
  * @author Apache Software Foundation
  * @version $Id$

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

@@ -18,7 +18,7 @@
 package org.apache.commons.codec;
 
 /**
- * Encodes a String into a String. 
+ * Defines common encoding methods for String encoders.
  *
  * @author Apache Software Foundation
  * @version $Id$

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

@@ -20,14 +20,10 @@
 import java.util.Comparator;
 
 /**
- * Strings are comparable, and this comparator allows 
- * you to configure it with an instance of a class
- * which implements StringEncoder.  This comparator
- * 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.
- *
+ * Compares Strings using a {@link StringEncoder}. This comparator 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 Apache Software Foundation
  * @version $Id$
  */
@@ -50,22 +46,24 @@ public StringEncoderComparator() {
 
     /**
      * Constructs a new instance with the given algorithm.
-     * @param stringEncoder the StringEncoder used for comparisons.
+     * 
+     * @param stringEncoder
+     *            the StringEncoder used for comparisons.
      */
     public StringEncoderComparator(StringEncoder stringEncoder) {
         this.stringEncoder = stringEncoder;
     }
 
     /**
-     * Compares two strings based not on the strings 
-     * themselves, but on an encoding of the two 
-     * strings using the StringEncoder this Comparator
-     * was created with.
+     * Compares two strings based not on the strings themselves, but on an encoding of the two strings using the
+     * StringEncoder this Comparator was created with.
      * 
      * If an {@link EncoderException} is encountered, return <code>0</code>.
      * 
-     * @param o1 the object to compare
-     * @param o2 the object to compare to
+     * @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
      */
@@ -77,8 +75,7 @@ public int compare(Object o1, Object o2) {
             Comparable s1 = (Comparable) this.stringEncoder.encode(o1);
             Comparable s2 = (Comparable) this.stringEncoder.encode(o2);
             compareCode = s1.compareTo(s2);
-        } 
-        catch (EncoderException ee) {
+        } catch (EncoderException ee) {
             compareCode = 0;
         }
         return compareCode;

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

@@ -23,7 +23,7 @@
 import org.apache.commons.codec.EncoderException;
 
 /**
- * Implements common Base-N codec functions.
+ * Abstract superclass for Base-N encoders and decoders.
  *
  * <p>
  * This class is not thread-safe.

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

@@ -22,7 +22,7 @@
 import java.io.InputStream;
 
 /**
- * Common base class for Base-N input streams.
+ * Abstract superclass for Base-N input streams.
  * 
  * @since 1.5
  */

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

@@ -22,7 +22,7 @@
 import java.io.OutputStream;
 
 /**
- * Common base class for Base-N output streams.
+ * Abstract superclass for Base-N output streams.
  * 
  * @since 1.5
  */

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

@@ -23,10 +23,10 @@
 import org.apache.commons.codec.EncoderException;
 
 /**
- * Translates between byte arrays and strings of "0"s and "1"s.
+ * Converts between byte arrays and strings of "0"s and "1"s.
  * 
  * TODO: may want to add more bit vector functions like and/or/xor/nand 
- * TODO: also might be good to generate boolean[] from byte[] et. cetera.
+ * TODO: also might be good to generate boolean[] from byte[] et cetera.
  * 
  * @author Apache Software Foundation
  * @since 1.3

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

@@ -26,7 +26,7 @@
 import org.apache.commons.codec.EncoderException;
 
 /**
- * Hex encoder and decoder. The charset used for certain operation can be set, the default is set in
+ * Converts hexadecimal Strings. The charset used for certain operation can be set, the default is set in
  * {@link #DEFAULT_CHARSET_NAME}
  * 
  * @since 1.1