Harmonize javadoc format style, add missing . at end of first paragraph.

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

Author: netomi

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

@@ -28,11 +28,10 @@ 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
+     *            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.
+     *             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

@@ -25,14 +25,13 @@
 public interface BinaryEncoder extends Encoder {
 
     /**
-     * Encodes a byte array and return the encoded data
-     * as a byte array.
+     * Encodes a byte array and return the encoded data as a byte array.
      *
      * @param source
-     *                  Data to be encoded
+     *            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.
+     *             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/Decoder.java

@@ -30,17 +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.
+     * 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
+     *            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.
+     *             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

@@ -55,11 +55,9 @@ public DecoderException(String message) {
 
     /**
      * 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
      * exception's detail message.
-     * </p>
      *
      * @param message
      *            The detail message which is saved for later retrieval by the {@link #getMessage()} method.

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

@@ -33,11 +33,11 @@ public interface Encoder {
      * <code>byte[]</code> or <code>String</code>s depending on the implementation used.
      *
      * @param source
-     *                  An object to encode
+     *            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.
+     *             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

@@ -28,10 +28,10 @@ public interface StringDecoder extends Decoder {
      * Decodes a String and returns a String.
      *
      * @param source
-     *                  the String to decode
+     *            the String to decode
      * @return the encoded String
      * @throws DecoderException
-     *                  thrown if there is an error condition during the Encoding process.
+     *             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

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

src/main/java/org/apache/commons/codec/net/BCodec.java

@@ -61,7 +61,7 @@ public BCodec() {
      * Constructor which allows for the selection of a default charset
      *
      * @param charset
-     *                  the default string charset to use.
+     *            the default string charset to use.
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      * @since 1.7
@@ -74,7 +74,7 @@ public BCodec(final Charset charset) {
      * Constructor which allows for the selection of a default charset
      *
      * @param charsetName
-     *                  the default charset to use.
+     *            the default charset to use.
      * @throws UnsupportedCharsetException
      *             If the named charset is unavailable
      * @since 1.7 throws UnsupportedCharsetException if the named charset is unavailable
@@ -109,13 +109,12 @@ protected byte[] doDecoding(byte[] bytes) {
      * Encodes a string into its Base64 form using the specified charset. Unsafe characters are escaped.
      *
      * @param value
-     *                  string to convert to Base64 form
+     *            string to convert to Base64 form
      * @param charset
-     *                  the charset for <code>value</code>
+     *            the charset for <code>value</code>
      * @return Base64 string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding process.
+     *             thrown if a failure condition is encountered during the encoding process.
      * @since 1.7
      */
     public String encode(final String value, final Charset charset) throws EncoderException {
@@ -129,13 +128,12 @@ public String encode(final String value, final Charset charset) throws EncoderEx
      * Encodes a string into its Base64 form using the specified charset. Unsafe characters are escaped.
      *
      * @param value
-     *                  string to convert to Base64 form
+     *            string to convert to Base64 form
      * @param charset
-     *                  the charset for <code>value</code>
+     *            the charset for <code>value</code>
      * @return Base64 string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     public String encode(final String value, final String charset) throws EncoderException {
         if (value == null) {
@@ -152,11 +150,10 @@ public String encode(final String value, final String charset) throws EncoderExc
      * Encodes a string into its Base64 form using the default charset. Unsafe characters are escaped.
      *
      * @param value
-     *                  string to convert to Base64 form
+     *            string to convert to Base64 form
      * @return Base64 string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     @Override
     public String encode(String value) throws EncoderException {
@@ -192,11 +189,10 @@ public String decode(String value) throws DecoderException {
      * Encodes an object into its Base64 form using the default charset. Unsafe characters are escaped.
      *
      * @param value
-     *                  object to convert to Base64 form
+     *            object to convert to Base64 form
      * @return Base64 object
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     @Override
     public Object encode(Object value) throws EncoderException {
@@ -216,13 +212,11 @@ public Object encode(Object value) throws EncoderException {
      * representation.
      *
      * @param value
-     *                  Base64 object to convert into its original form
-     *
+     *            Base64 object to convert into its original form
      * @return original object
-     *
      * @throws DecoderException
-     *                  Thrown if the argument is not a <code>String</code>. Thrown if a failure condition is
-     *                  encountered during the decode process.
+     *             Thrown if the argument is not a <code>String</code>. Thrown if a failure condition is encountered
+     *             during the decode process.
      */
     @Override
     public Object decode(Object value) throws DecoderException {

src/main/java/org/apache/commons/codec/net/QCodec.java

@@ -118,10 +118,10 @@ public QCodec() {
     }
 
     /**
-     * Constructor which allows for the selection of a default charset
+     * Constructor which allows for the selection of a default charset.
      *
      * @param charset
-     *                  the default string charset to use.
+     *            the default string charset to use.
      *
      * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
      * @since 1.7
@@ -132,10 +132,10 @@ public QCodec(final Charset charset) {
     }
 
     /**
-     * Constructor which allows for the selection of a default charset
+     * Constructor which allows for the selection of a default charset.
      *
      * @param charsetName
-     *                  the charset to use.
+     *            the charset to use.
      * @throws UnsupportedCharsetException
      *             If the named charset is unavailable
      * @since 1.7 throws UnsupportedCharsetException if the named charset is unavailable
@@ -197,13 +197,12 @@ protected byte[] doDecoding(byte[] bytes) throws DecoderException {
      * Encodes a string into its quoted-printable form using the specified charset. Unsafe characters are escaped.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @param charset
-     *                  the charset for str
+     *            the charset for str
      * @return quoted-printable string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding process.
+     *             thrown if a failure condition is encountered during the encoding process.
      * @since 1.7
      */
     public String encode(final String str, final Charset charset) throws EncoderException {
@@ -217,13 +216,12 @@ public String encode(final String str, final Charset charset) throws EncoderExce
      * Encodes a string into its quoted-printable form using the specified charset. Unsafe characters are escaped.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @param charset
-     *                  the charset for str
+     *            the charset for str
      * @return quoted-printable string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     public String encode(final String str, final String charset) throws EncoderException {
         if (str == null) {
@@ -240,11 +238,10 @@ public String encode(final String str, final String charset) throws EncoderExcep
      * Encodes a string into its quoted-printable form using the default charset. Unsafe characters are escaped.
      *
      * @param str
-     *                  string to convert to quoted-printable form
+     *            string to convert to quoted-printable form
      * @return quoted-printable string
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     @Override
     public String encode(String str) throws EncoderException {
@@ -259,12 +256,10 @@ public String encode(String str) throws EncoderException {
      * representation.
      *
      * @param str
-     *                  quoted-printable string to convert into its original form
-     *
+     *            quoted-printable string to convert into its original form
      * @return original string
-     *
      * @throws DecoderException
-     *                  A decoder exception is thrown if a failure condition is encountered during the decode process.
+     *             A decoder exception is thrown if a failure condition is encountered during the decode process.
      */
     @Override
     public String decode(String str) throws DecoderException {
@@ -282,11 +277,10 @@ public String decode(String str) throws DecoderException {
      * Encodes an object into its quoted-printable form using the default charset. Unsafe characters are escaped.
      *
      * @param obj
-     *                  object to convert to quoted-printable form
+     *            object to convert to quoted-printable form
      * @return quoted-printable object
-     *
      * @throws EncoderException
-     *                  thrown if a failure condition is encountered during the encoding process.
+     *             thrown if a failure condition is encountered during the encoding process.
      */
     @Override
     public Object encode(Object obj) throws EncoderException {
@@ -306,13 +300,11 @@ public Object encode(Object obj) throws EncoderException {
      * representation.
      *
      * @param obj
-     *                  quoted-printable object to convert into its original form
-     *
+     *            quoted-printable object to convert into its original form
      * @return original object
-     *
      * @throws DecoderException
-     *                  Thrown if the argument is not a <code>String</code>. Thrown if a failure condition is
-     *                  encountered during the decode process.
+     *             Thrown if the argument is not a <code>String</code>. Thrown if a failure condition is encountered
+     *             during the decode process.
      */
     @Override
     public Object decode(Object obj) throws DecoderException {
@@ -359,7 +351,7 @@ public boolean isEncodeBlanks() {
      * Defines whether optional transformation of SPACE characters is to be used
      *
      * @param b
-     *                  {@code true} if SPACE characters are to be transformed, {@code false} otherwise
+     *            {@code true} if SPACE characters are to be transformed, {@code false} otherwise
      */
     public void setEncodeBlanks(boolean b) {
         this.encodeBlanks = b;