Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Jakarta Commons Developers List" <commons-dev@jakarta.apache.org>
Date: 4 Oct 2003 16:24:56 -0000
Message-ID: <20031004162456.13741.qmail@minotaur.apache.org>
From: tobrien@apache.org
To: jakarta-commons-cvs@apache.org
Subject: cvs commit: jakarta-commons/codec/src/java/org/apache/commons/codec
 EncoderException.java

tobrien     2003/10/04 09:24:56

  Modified:    codec/src/java/org/apache/commons/codec
                        EncoderException.java
  Log:
  Adds some clarification to the class level Javadoc, and
  also rewords the constructor's javadoc to sound less 'robotic'
  
  Revision  Changes    Path
  1.5       +7 -5      jakarta-commons/codec/src/java/org/apache/commons/codec/EncoderException.java
  
  Index: EncoderException.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/codec/src/java/org/apache/commons/codec/EncoderException.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- EncoderException.java	14 Aug 2003 07:40:17 -0000	1.4
  +++ EncoderException.java	4 Oct 2003 16:24:56 -0000	1.5
  @@ -54,7 +54,10 @@
   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
  @@ -63,10 +66,9 @@
   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);
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org