Adds some clarification to the class level Javadoc, and

also rewords the constructor's javadoc to sound less 'robotic'


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

Author: Timothy O'Brien

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

@@ -54,19 +54,21 @@
 package org.apache.commons.codec;
 
 /**
- * Thrown when there is a failure condition during the encoding process.
+ * 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.
  * 
  * @author Tim O'Brien
  * @author Gary Gregory
- * @version $Id: EncoderException.java,v 1.4 2003/08/14 07:40:17 ggregory Exp $
+ * @version $Id: EncoderException.java,v 1.5 2003/10/04 16:24:56 tobrien Exp $
  */
 public class EncoderException extends Exception {
 
     /**
-     * Creates a new instance of this exception with
-     * an informative message.
+     * Creates a new instance of this exception with an useful message.
      * 
-     * @param pMessage a human intelligible message
+     * @param pMessage a useful message relating to the encoder specific error.
      */
     public EncoderException(String pMessage) {
         super(pMessage);