Checkstyle fixes, harmonised javadoc for param and throws tags.

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

Author: netomi

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

@@ -41,8 +41,8 @@
  * The instance field {@link #encodeBlanks} is mutable {@link #setEncodeBlanks(boolean)}
  * but is not volatile, and accesses are not synchronised.
  * If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronisation
- * is used to ensure safe publication of the value between threads, and must not invoke {@link #setEncodeBlanks(boolean)}
- * after initial setup.
+ * is used to ensure safe publication of the value between threads, and must not invoke
+ * {@link #setEncodeBlanks(boolean)} after initial setup.
  *
  * @see <a href="http://www.ietf.org/rfc/rfc1522.txt">MIME (Multipurpose Internet Mail Extensions) Part Two: Message
  *          Header Extensions for Non-ASCII Text</a>

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

@@ -137,11 +137,9 @@ private static final void encodeQuotedPrintable(int b, ByteArrayOutputStream buf
 
     /**
      * Encodes an array of bytes into an array of quoted-printable 7-bit characters. Unsafe characters are escaped.
-     *
      * <p>
      * This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
      * RFC 1521 and is suitable for encoding binary data and unformatted text.
-     * </p>
      *
      * @param printable
      *                  bitset of characters deemed quoted-printable
@@ -174,11 +172,9 @@ public static final byte[] encodeQuotedPrintable(BitSet printable, byte[] bytes)
     /**
      * Decodes an array quoted-printable characters into an array of original bytes. Escaped characters are converted
      * back to their original representation.
-     *
      * <p>
      * This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
      * RFC 1521.
-     * </p>
      *
      * @param bytes
      *                  array of quoted-printable characters
@@ -210,11 +206,9 @@ public static final byte[] decodeQuotedPrintable(byte[] bytes) throws DecoderExc
 
     /**
      * Encodes an array of bytes into an array of quoted-printable 7-bit characters. Unsafe characters are escaped.
-     *
      * <p>
      * This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
      * RFC 1521 and is suitable for encoding binary data and unformatted text.
-     * </p>
      *
      * @param bytes
      *                  array of bytes to be encoded
@@ -228,11 +222,9 @@ public byte[] encode(byte[] bytes) {
     /**
      * Decodes an array of quoted-printable characters into an array of original bytes. Escaped characters are converted
      * back to their original representation.
-     *
      * <p>
      * This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
      * RFC 1521.
-     * </p>
      *
      * @param bytes
      *                  array of quoted-printable characters
@@ -247,11 +239,9 @@ public byte[] decode(byte[] bytes) throws DecoderException {
 
     /**
      * Encodes a string into its quoted-printable form using the default string charset. Unsafe characters are escaped.
-     *
      * <p>
      * This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
      * RFC 1521 and is suitable for encoding binary data.
-     * </p>
      *
      * @param str
      *                  string to convert to quoted-printable form
@@ -332,8 +322,8 @@ public String decode(String str) throws DecoderException {
      *                  string to convert to a quoted-printable form
      * @return quoted-printable object
      * @throws EncoderException
-     *                  Thrown if quoted-printable encoding is not applicable to objects of this type or if encoding is
-     *                  unsuccessful
+     *                  Thrown if quoted-printable encoding is not applicable to objects of this type or if
+     *                  encoding is unsuccessful
      */
     @Override
     public Object encode(Object obj) throws EncoderException {
@@ -351,15 +341,15 @@ public Object encode(Object obj) throws EncoderException {
     }
 
     /**
-     * Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original
-     * representation.
+     * Decodes a quoted-printable object into its original form. Escaped characters are converted back to their
+     * original representation.
      *
      * @param obj
      *                  quoted-printable object to convert into its original form
      * @return original object
      * @throws DecoderException
-     *                  Thrown if the argument is not a <code>String</code> or <code>byte[]</code>. Thrown if a failure condition is
-     *                  encountered during the decode process.
+     *                  Thrown if the argument is not a <code>String</code> or <code>byte[]</code>.
+     *                  Thrown if a failure condition is encountered during the decode process.
      */
     @Override
     public Object decode(Object obj) throws DecoderException {
@@ -397,11 +387,9 @@ public String getDefaultCharset() {
 
     /**
      * Encodes a string into its quoted-printable form using the specified charset. Unsafe characters are escaped.
-     *
      * <p>
      * This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
      * RFC 1521 and is suitable for encoding binary data and unformatted text.
-     * </p>
      *
      * @param str
      *                  string to convert to quoted-printable form
@@ -419,11 +407,9 @@ public String encode(String str, Charset charset) {
 
     /**
      * Encodes a string into its quoted-printable form using the specified charset. Unsafe characters are escaped.
-     *
      * <p>
      * This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
      * RFC 1521 and is suitable for encoding binary data and unformatted text.
-     * </p>
      *
      * @param str
      *                  string to convert to quoted-printable form

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

@@ -113,9 +113,9 @@ public URLCodec(String charset) {
      * Encodes an array of bytes into an array of URL safe 7-bit characters. Unsafe characters are escaped.
      *
      * @param urlsafe
-     *            bitset of characters deemed URL safe
+     *                  bitset of characters deemed URL safe
      * @param bytes
-     *            array of bytes to convert to URL safe characters
+     *                  array of bytes to convert to URL safe characters
      * @return array of bytes containing URL safe characters
      */
     public static final byte[] encodeUrl(BitSet urlsafe, byte[] bytes) {
@@ -153,9 +153,11 @@ public static final byte[] encodeUrl(BitSet urlsafe, byte[] bytes) {
      * original bytes. Escaped characters are converted back to their
      * original representation.
      *
-     * @param bytes array of URL safe characters
+     * @param bytes
+     *                  array of URL safe characters
      * @return array of original bytes
-     * @throws DecoderException Thrown if URL decoding is unsuccessful
+     * @throws DecoderException
+     *                  Thrown if URL decoding is unsuccessful
      */
     public static final byte[] decodeUrl(byte[] bytes) throws DecoderException {
         if (bytes == null) {
@@ -185,7 +187,8 @@ public static final byte[] decodeUrl(byte[] bytes) throws DecoderException {
      * Encodes an array of bytes into an array of URL safe 7-bit
      * characters. Unsafe characters are escaped.
      *
-     * @param bytes array of bytes to convert to URL safe characters
+     * @param bytes
+     *                  array of bytes to convert to URL safe characters
      * @return array of bytes containing URL safe characters
      */
     @Override
@@ -199,9 +202,11 @@ public byte[] encode(byte[] bytes) {
      * original bytes. Escaped characters are converted back to their
      * original representation.
      *
-     * @param bytes array of URL safe characters
+     * @param bytes
+     *                  array of URL safe characters
      * @return array of original bytes
-     * @throws DecoderException Thrown if URL decoding is unsuccessful
+     * @throws DecoderException
+     *                  Thrown if URL decoding is unsuccessful
      */
     @Override
     public byte[] decode(byte[] bytes) throws DecoderException {
@@ -212,12 +217,12 @@ public byte[] decode(byte[] bytes) throws DecoderException {
      * Encodes a string into its URL safe form using the specified string charset. Unsafe characters are escaped.
      *
      * @param str
-     *            string to convert to a URL safe form
+     *                  string to convert to a URL safe form
      * @param charset
-     *            the charset for str
+     *                  the charset for str
      * @return URL safe string
      * @throws UnsupportedEncodingException
-     *             Thrown if charset is not supported
+     *                  Thrown if charset is not supported
      */
     public String encode(String str, String charset) throws UnsupportedEncodingException {
         if (str == null) {
@@ -230,9 +235,11 @@ public String encode(String str, String charset) throws UnsupportedEncodingExcep
      * Encodes a string into its URL safe form using the default string
      * charset. Unsafe characters are escaped.
      *
-     * @param str string to convert to a URL safe form
+     * @param str
+     *                  string to convert to a URL safe form
      * @return URL safe string
-     * @throws EncoderException Thrown if URL encoding is unsuccessful
+     * @throws EncoderException
+     *                  Thrown if URL encoding is unsuccessful
      *
      * @see #getDefaultCharset()
      */
@@ -254,12 +261,15 @@ public String encode(String str) throws EncoderException {
      * specified encoding. Escaped characters are converted back
      * to their original representation.
      *
-     * @param str URL safe string to convert into its original form
-     * @param charset the original string charset
+     * @param str
+     *                  URL safe string to convert into its original form
+     * @param charset
+     *                  the original string charset
      * @return original string
-     * @throws DecoderException Thrown if URL decoding is unsuccessful
-     * @throws UnsupportedEncodingException Thrown if charset is not
-     *                                      supported
+     * @throws DecoderException
+     *                  Thrown if URL decoding is unsuccessful
+     * @throws UnsupportedEncodingException
+     *                  Thrown if charset is not supported
      */
     public String decode(String str, String charset) throws DecoderException, UnsupportedEncodingException {
         if (str == null) {
@@ -273,10 +283,11 @@ public String decode(String str, String charset) throws DecoderException, Unsupp
      * string charset. Escaped characters are converted back to their
      * original representation.
      *
-     * @param str URL safe string to convert into its original form
+     * @param str
+     *                  URL safe string to convert into its original form
      * @return original string
-     * @throws DecoderException Thrown if URL decoding is unsuccessful
-     *
+     * @throws DecoderException
+     *                  Thrown if URL decoding is unsuccessful
      * @see #getDefaultCharset()
      */
     @Override
@@ -292,14 +303,13 @@ public String decode(String str) throws DecoderException {
     }
 
     /**
-     * Encodes an object into its URL safe form. Unsafe characters are
-     * escaped.
+     * Encodes an object into its URL safe form. Unsafe characters are escaped.
      *
-     * @param obj string to convert to a URL safe form
+     * @param obj
+     *                  string to convert to a URL safe form
      * @return URL safe object
-     * @throws EncoderException Thrown if URL encoding is not
-     *                          applicable to objects of this type or
-     *                          if encoding is unsuccessful
+     * @throws EncoderException
+     *                  Thrown if URL encoding is not applicable to objects of this type or if encoding is unsuccessful
      */
     @Override
     public Object encode(Object obj) throws EncoderException {
@@ -324,8 +334,8 @@ public Object encode(Object obj) throws EncoderException {
      *                  URL safe object to convert into its original form
      * @return original object
      * @throws DecoderException
-     *                  Thrown if the argument is not a <code>String</code> or <code>byte[]</code>. Thrown if a failure condition is
-     *                  encountered during the decode process.
+     *                  Thrown if the argument is not a <code>String</code> or <code>byte[]</code>.
+     *                  Thrown if a failure condition is encountered during the decode process.
      */
     @Override
     public Object decode(Object obj) throws DecoderException {