Harmonised javadoc, removed unneeded p tags.

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

Author: netomi

src/main/java/org/apache/commons/codec/BinaryDecoder.java

@@ -27,14 +27,12 @@ public interface BinaryDecoder extends Decoder {
     /**
      * Decodes a byte array and returns the results as a byte array.
      *
-     * @param source A byte array which has been encoded with the
-     *      appropriate encoder
-     *
+     * @param source
+     *                  A byte array which has been encoded with the appropriate encoder
      * @return a byte array that contains decoded content
-     *
-     * @throws DecoderException A decoder exception is thrown
-     *          if a Decoder encounters a failure condition during
-     *          the decode process.
+     * @throws DecoderException
+     *                  A decoder exception is thrown if a Decoder encounters a failure condition during
+     *                  the decode process.
      */
     byte[] decode(byte[] source) throws DecoderException;
 }

src/main/java/org/apache/commons/codec/BinaryEncoder.java

@@ -28,13 +28,11 @@ public interface BinaryEncoder extends Encoder {
      * Encodes a byte array and return the encoded data
      * as a byte array.
      *
-     * @param source Data to be encoded
-     *
+     * @param source
+     *                  Data to be encoded
      * @return A byte array containing the encoded data
-     *
-     * @throws EncoderException thrown if the Encoder
-     *      encounters a failure condition during the
-     *      encoding process.
+     * @throws EncoderException
+     *                  thrown if the Encoder encounters a failure condition during the encoding process.
      */
     byte[] encode(byte[] source) throws EncoderException;
 }

src/main/java/org/apache/commons/codec/CharEncoding.java

@@ -57,71 +57,55 @@
  */
 public class CharEncoding {
     /**
-     * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. </p>
+     * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final String ISO_8859_1 = "ISO-8859-1";
 
     /**
-     * <p>
      * Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final String US_ASCII = "US-ASCII";
 
     /**
-     * <p>
      * Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark
      * (either order accepted on input, big-endian used on output)
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final String UTF_16 = "UTF-16";
 
     /**
-     * <p>
      * Sixteen-bit Unicode Transformation Format, big-endian byte order.
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final String UTF_16BE = "UTF-16BE";
 
     /**
-     * <p>
      * Sixteen-bit Unicode Transformation Format, little-endian byte order.
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final String UTF_16LE = "UTF-16LE";
 
     /**
-     * <p>
      * Eight-bit Unicode Transformation Format.
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */

src/main/java/org/apache/commons/codec/Charsets.java

@@ -89,71 +89,55 @@ public static Charset toCharset(String charset) {
     }
 
     /**
-     * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. </p>
+     * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final Charset ISO_8859_1 = Charset.forName(CharEncoding.ISO_8859_1);
 
     /**
-     * <p>
      * Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final Charset US_ASCII = Charset.forName(CharEncoding.US_ASCII);
 
     /**
-     * <p>
      * Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark
      * (either order accepted on input, big-endian used on output)
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final Charset UTF_16 = Charset.forName(CharEncoding.UTF_16);
 
     /**
-     * <p>
      * Sixteen-bit Unicode Transformation Format, big-endian byte order.
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final Charset UTF_16BE = Charset.forName(CharEncoding.UTF_16BE);
 
     /**
-     * <p>
      * Sixteen-bit Unicode Transformation Format, little-endian byte order.
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */
     public static final Charset UTF_16LE = Charset.forName(CharEncoding.UTF_16LE);
 
     /**
-     * <p>
      * Eight-bit Unicode Transformation Format.
-     * </p>
      * <p>
      * Every implementation of the Java platform is required to support this character encoding.
-     * </p>
      *
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      */

src/main/java/org/apache/commons/codec/Decoder.java

@@ -30,22 +30,17 @@
 public interface Decoder {
 
     /**
-     * Decodes an "encoded" Object and returns a "decoded"
-     * Object.  Note that the implementation of this
-     * interface will try to cast the Object parameter
-     * to the specific type expected by a particular Decoder
-     * implementation.  If a {@link ClassCastException} occurs
-     * this decode method will throw a DecoderException.
-     *
-     * @param source the object to decode
+     * Decodes an "encoded" Object and returns a "decoded" Object.  Note that the implementation of this
+     * interface will try to cast the Object parameter to the specific type expected by a particular Decoder
+     * implementation.  If a {@link ClassCastException} occurs this decode method will throw a DecoderException.
      *
+     * @param source
+     *                  the object to decode
      * @return a 'decoded" object
-     *
-     * @throws DecoderException a decoder exception can
-     * be thrown for any number of reasons.  Some good
-     * candidates are that the parameter passed to this
-     * method is null, a param cannot be cast to the
-     * appropriate type for a specific encoder.
+     * @throws DecoderException
+     *                  a decoder exception can be thrown for any number of reasons.  Some good candidates are that
+     *                  the parameter passed to this method is null, a param cannot be cast to the appropriate type
+     *                  for a specific encoder.
      */
     Object decode(Object source) throws DecoderException;
 }

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

@@ -54,7 +54,7 @@ public DecoderException(String message) {
     }
 
     /**
-     * Constructsa new exception with the specified detail message and cause.
+     * Constructs a new exception with the specified detail message and cause.
      *
      * <p>
      * Note that the detail message associated with <code>cause</code> is not automatically incorporated into this

src/main/java/org/apache/commons/codec/Encoder.java

@@ -29,17 +29,15 @@
 public interface Encoder {
 
     /**
-     * Encodes an "Object" and returns the encoded content
-     * as an Object.  The Objects here may just be <code>byte[]</code>
-     * or <code>String</code>s depending on the implementation used.
-     *
-     * @param source An object to encode
+     * Encodes an "Object" and returns the encoded content as an Object. The Objects here may just be
+     * <code>byte[]</code> or <code>String</code>s depending on the implementation used.
      *
+     * @param source
+     *                  An object to encode
      * @return An "encoded" Object
-     *
-     * @throws EncoderException an encoder exception is
-     *  thrown if the encoder experiences a failure
-     *  condition during the encoding process.
+     * @throws EncoderException
+     *                  An encoder exception is thrown if the encoder experiences a failure condition during
+     *                  the encoding process.
      */
     Object encode(Object source) throws EncoderException;
 }

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

@@ -27,12 +27,11 @@ public interface StringDecoder extends Decoder {
     /**
      * Decodes a String and returns a String.
      *
-     * @param source the String to decode
-     *
+     * @param source
+     *                  the String to decode
      * @return the encoded String
-     *
-     * @throws DecoderException thrown if there is
-     *  an error condition during the Encoding process.
+     * @throws DecoderException
+     *                  thrown if there is an error condition during the Encoding process.
      */
     String decode(String source) throws DecoderException;
 }

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

@@ -27,12 +27,11 @@ public interface StringEncoder extends Encoder {
     /**
      * Encodes a String and returns a String.
      *
-     * @param source the String to encode
-     *
+     * @param source
+     *                  the String to encode
      * @return the encoded String
-     *
-     * @throws EncoderException thrown if there is
-     *  an error condition during the encoding process.
+     * @throws EncoderException
+     *                  thrown if there is an error condition during the encoding process.
      */
     String encode(String source) throws EncoderException;
 }