Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.

Author: garydgregory

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

@@ -29,17 +29,17 @@
  * </p>
  *
  * <ul>
- * <li><code>US-ASCII</code><p>
+ * <li>{@code US-ASCII}<p>
  * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</p></li>
- * <li><code>ISO-8859-1</code><p>
+ * <li>{@code ISO-8859-1}<p>
  * ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</p></li>
- * <li><code>UTF-8</code><p>
+ * <li>{@code UTF-8}<p>
  * Eight-bit Unicode Transformation Format.</p></li>
- * <li><code>UTF-16BE</code><p>
+ * <li>{@code UTF-16BE}<p>
  * Sixteen-bit Unicode Transformation Format, big-endian byte order.</p></li>
- * <li><code>UTF-16LE</code><p>
+ * <li>{@code UTF-16LE}<p>
  * Sixteen-bit Unicode Transformation Format, little-endian byte order.</p></li>
- * <li><code>UTF-16</code><p>
+ * <li>{@code UTF-16}<p>
  * Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
  * accepted on input, big-endian used on output.)</p></li>
  * </ul>

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

@@ -30,17 +30,17 @@
  * </p>
  *
  * <ul>
- * <li><code>US-ASCII</code><p>
+ * <li>{@code US-ASCII}<p>
  * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</p></li>
- * <li><code>ISO-8859-1</code><p>
+ * <li>{@code ISO-8859-1}<p>
  * ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</p></li>
- * <li><code>UTF-8</code><p>
+ * <li>{@code UTF-8}<p>
  * Eight-bit Unicode Transformation Format.</p></li>
- * <li><code>UTF-16BE</code><p>
+ * <li>{@code UTF-16BE}<p>
  * Sixteen-bit Unicode Transformation Format, big-endian byte order.</p></li>
- * <li><code>UTF-16LE</code><p>
+ * <li>{@code UTF-16LE}<p>
  * Sixteen-bit Unicode Transformation Format, little-endian byte order.</p></li>
- * <li><code>UTF-16</code><p>
+ * <li>{@code UTF-16}<p>
  * Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
  * accepted on input, big-endian used on output.)</p></li>
  * </ul>

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

@@ -32,7 +32,7 @@ public class DecoderException extends Exception {
     private static final long serialVersionUID = 1L;
 
     /**
-     * Constructs a new exception with <code>null</code> as its detail message. The cause is not initialized, and may
+     * Constructs a new exception with {@code null} as its detail message. The cause is not initialized, and may
      * subsequently be initialized by a call to {@link #initCause}.
      *
      * @since 1.4
@@ -55,13 +55,13 @@ public DecoderException(final 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
+     * Note that the detail message associated with {@code cause} is not automatically incorporated into this
      * exception's detail message.
      *
      * @param message
      *            The detail message which is saved for later retrieval by the {@link #getMessage()} method.
      * @param cause
-     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code>
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */
@@ -71,11 +71,11 @@ public DecoderException(final String message, final Throwable cause) {
 
     /**
      * Constructs a new exception with the specified cause and a detail message of <code>(cause==null ?
-     * null : cause.toString())</code> (which typically contains the class and detail message of <code>cause</code>).
+     * null : cause.toString())</code> (which typically contains the class and detail message of {@code cause}).
      * This constructor is useful for exceptions that are little more than wrappers for other throwables.
      *
      * @param cause
-     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code>
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */

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

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

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

@@ -33,7 +33,7 @@ public class EncoderException extends Exception {
     private static final long serialVersionUID = 1L;
 
     /**
-     * Constructs a new exception with <code>null</code> as its detail message. The cause is not initialized, and may
+     * Constructs a new exception with {@code null} as its detail message. The cause is not initialized, and may
      * subsequently be initialized by a call to {@link #initCause}.
      *
      * @since 1.4
@@ -57,14 +57,14 @@ public EncoderException(final 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
+     * Note that the detail message associated with {@code cause} 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.
      * @param cause
-     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code>
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */
@@ -74,11 +74,11 @@ public EncoderException(final String message, final Throwable cause) {
 
     /**
      * Constructs a new exception with the specified cause and a detail message of <code>(cause==null ?
-     * null : cause.toString())</code> (which typically contains the class and detail message of <code>cause</code>).
+     * null : cause.toString())</code> (which typically contains the class and detail message of {@code cause}).
      * This constructor is useful for exceptions that are little more than wrappers for other throwables.
      *
      * @param cause
-     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code>
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */

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

@@ -61,7 +61,7 @@ public StringEncoderComparator(final StringEncoder stringEncoder) {
      * Compares two strings based not on the strings themselves, but on an encoding of the two strings using the
      * StringEncoder this Comparator was created with.
      *
-     * If an {@link EncoderException} is encountered, return <code>0</code>.
+     * If an {@link EncoderException} is encountered, return {@code 0}.
      *
      * @param o1
      *            the object to compare

src/main/java/org/apache/commons/codec/binary/Base32.java

@@ -140,7 +140,7 @@ public class Base32 extends BaseNCodec {
 
     /**
      * Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.
-     * <code>decodeSize = {@link #BYTES_PER_ENCODED_BLOCK} - 1 + lineSeparator.length;</code>
+     * {@code decodeSize = {@link #BYTES_PER_ENCODED_BLOCK} - 1 + lineSeparator.length;}
      */
     private final int decodeSize;
 
@@ -151,7 +151,7 @@ public class Base32 extends BaseNCodec {
 
     /**
      * Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.
-     * <code>encodeSize = {@link #BYTES_PER_ENCODED_BLOCK} + lineSeparator.length;</code>
+     * {@code encodeSize = {@link #BYTES_PER_ENCODED_BLOCK} + lineSeparator.length;}
      */
     private final int encodeSize;
 

src/main/java/org/apache/commons/codec/binary/Base64.java

@@ -154,13 +154,13 @@ public class Base64 extends BaseNCodec {
 
     /**
      * Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.
-     * <code>decodeSize = 3 + lineSeparator.length;</code>
+     * {@code decodeSize = 3 + lineSeparator.length;}
      */
     private final int decodeSize;
 
     /**
      * Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.
-     * <code>encodeSize = 4 + lineSeparator.length;</code>
+     * {@code encodeSize = 4 + lineSeparator.length;}
      */
     private final int encodeSize;
 
@@ -189,8 +189,8 @@ public Base64() {
      * </p>
      *
      * @param urlSafe
-     *            if <code>true</code>, URL-safe encoding is used. In most cases this should be set to
-     *            <code>false</code>.
+     *            if {@code true}, URL-safe encoding is used. In most cases this should be set to
+     *            {@code false}.
      * @since 1.4
      */
     public Base64(final boolean urlSafe) {
@@ -495,8 +495,8 @@ void decode(final byte[] in, int inPos, final int inAvail, final Context context
      *
      * @param arrayOctet
      *            byte array to test
-     * @return <code>true</code> if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
-     *         <code>false</code>, otherwise
+     * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
+     *         {@code false}, otherwise
      * @deprecated 1.5 Use {@link #isBase64(byte[])}, will be removed in 2.0.
      */
     @Deprecated
@@ -505,11 +505,11 @@ public static boolean isArrayByteBase64(final byte[] arrayOctet) {
     }
 
     /**
-     * Returns whether or not the <code>octet</code> is in the base 64 alphabet.
+     * Returns whether or not the {@code octet} is in the base 64 alphabet.
      *
      * @param octet
      *            The value to test
-     * @return <code>true</code> if the value is defined in the the base 64 alphabet, <code>false</code> otherwise.
+     * @return {@code true} if the value is defined in the the base 64 alphabet, {@code false} otherwise.
      * @since 1.4
      */
     public static boolean isBase64(final byte octet) {
@@ -522,8 +522,8 @@ public static boolean isBase64(final byte octet) {
      *
      * @param base64
      *            String to test
-     * @return <code>true</code> if all characters in the String are valid characters in the Base64 alphabet or if
-     *         the String is empty; <code>false</code>, otherwise
+     * @return {@code true} if all characters in the String are valid characters in the Base64 alphabet or if
+     *         the String is empty; {@code false}, otherwise
      *  @since 1.5
      */
     public static boolean isBase64(final String base64) {
@@ -536,8 +536,8 @@ public static boolean isBase64(final String base64) {
      *
      * @param arrayOctet
      *            byte array to test
-     * @return <code>true</code> if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
-     *         <code>false</code>, otherwise
+     * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
+     *         {@code false}, otherwise
      * @since 1.5
      */
     public static boolean isBase64(final byte[] arrayOctet) {
@@ -618,7 +618,7 @@ public static byte[] encodeBase64Chunked(final byte[] binaryData) {
      * @param binaryData
      *            Array containing binary data to encode.
      * @param isChunked
-     *            if <code>true</code> this encoder will chunk the base64 output into 76 character blocks
+     *            if {@code true} this encoder will chunk the base64 output into 76 character blocks
      * @return Base64-encoded data.
      * @throws IllegalArgumentException
      *             Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE}
@@ -633,9 +633,9 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
      * @param binaryData
      *            Array containing binary data to encode.
      * @param isChunked
-     *            if <code>true</code> this encoder will chunk the base64 output into 76 character blocks
+     *            if {@code true} this encoder will chunk the base64 output into 76 character blocks
      * @param urlSafe
-     *            if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters.
+     *            if {@code true} this encoder will emit - and _ instead of the usual + and / characters.
      *            <b>Note: no padding is added when encoding using the URL-safe alphabet.</b>
      * @return Base64-encoded data.
      * @throws IllegalArgumentException
@@ -652,9 +652,9 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
      * @param binaryData
      *            Array containing binary data to encode.
      * @param isChunked
-     *            if <code>true</code> this encoder will chunk the base64 output into 76 character blocks
+     *            if {@code true} this encoder will chunk the base64 output into 76 character blocks
      * @param urlSafe
-     *            if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters.
+     *            if {@code true} this encoder will emit - and _ instead of the usual + and / characters.
      *            <b>Note: no padding is added when encoding using the URL-safe alphabet.</b>
      * @param maxResultSize
      *            The maximum result size to accept.
@@ -745,10 +745,10 @@ public static byte[] encodeInteger(final BigInteger bigInt) {
     }
 
     /**
-     * Returns a byte-array representation of a <code>BigInteger</code> without sign bit.
+     * Returns a byte-array representation of a {@code BigInteger} without sign bit.
      *
      * @param bigInt
-     *            <code>BigInteger</code> to be converted
+     *            {@code BigInteger} to be converted
      * @return a byte array representation of the BigInteger parameter
      */
     static byte[] toIntegerBytes(final BigInteger bigInt) {
@@ -776,11 +776,11 @@ static byte[] toIntegerBytes(final BigInteger bigInt) {
     }
 
     /**
-     * Returns whether or not the <code>octet</code> is in the Base64 alphabet.
+     * Returns whether or not the {@code octet} is in the Base64 alphabet.
      *
      * @param octet
      *            The value to test
-     * @return <code>true</code> if the value is defined in the the Base64 alphabet <code>false</code> otherwise.
+     * @return {@code true} if the value is defined in the the Base64 alphabet {@code false} otherwise.
      */
     @Override
     protected boolean isInAlphabet(final byte octet) {

src/main/java/org/apache/commons/codec/binary/BaseNCodec.java

@@ -191,11 +191,11 @@ public String toString() {
     private final int chunkSeparatorLength;
 
     /**
-     * Note <code>lineLength</code> is rounded down to the nearest multiple of the encoded block size.
-     * If <code>chunkSeparatorLength</code> is zero, then chunking is disabled.
+     * Note {@code lineLength} is rounded down to the nearest multiple of the encoded block size.
+     * If {@code chunkSeparatorLength} is zero, then chunking is disabled.
      * @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
      * @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
-     * @param lineLength if &gt; 0, use chunking with a length <code>lineLength</code>
+     * @param lineLength if &gt; 0, use chunking with a length {@code lineLength}
      * @param chunkSeparatorLength the chunk separator length, if relevant
      */
     protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
@@ -204,11 +204,11 @@ protected BaseNCodec(final int unencodedBlockSize, final int encodedBlockSize,
     }
 
     /**
-     * Note <code>lineLength</code> is rounded down to the nearest multiple of the encoded block size.
-     * If <code>chunkSeparatorLength</code> is zero, then chunking is disabled.
+     * Note {@code lineLength} is rounded down to the nearest multiple of the encoded block size.
+     * If {@code chunkSeparatorLength} is zero, then chunking is disabled.
      * @param unencodedBlockSize the size of an unencoded block (e.g. Base64 = 3)
      * @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
-     * @param lineLength if &gt; 0, use chunking with a length <code>lineLength</code>
+     * @param lineLength if &gt; 0, use chunking with a length {@code lineLength}
      * @param chunkSeparatorLength the chunk separator length, if relevant
      * @param pad byte used as padding byte.
      */
@@ -321,7 +321,7 @@ private static int createPositiveCapacity(int minCapacity) {
     }
 
     /**
-     * Ensure that the buffer has room for <code>size</code> bytes
+     * Ensure that the buffer has room for {@code size} bytes
      *
      * @param size minimum spare space required
      * @param context the context to be used
@@ -532,12 +532,12 @@ public byte[] encode(final byte[] pArray, final int offset, final int length) {
     abstract void decode(byte[] pArray, int i, int length, Context context);
 
     /**
-     * Returns whether or not the <code>octet</code> is in the current alphabet.
+     * Returns whether or not the {@code octet} is in the current alphabet.
      * Does not allow whitespace or pad.
      *
      * @param value The value to test
      *
-     * @return <code>true</code> if the value is defined in the current alphabet, <code>false</code> otherwise.
+     * @return {@code true} if the value is defined in the current alphabet, {@code false} otherwise.
      */
     protected abstract boolean isInAlphabet(byte value);
 
@@ -546,10 +546,10 @@ public byte[] encode(final byte[] pArray, final int offset, final int length) {
      * The method optionally treats whitespace and pad as valid.
      *
      * @param arrayOctet byte array to test
-     * @param allowWSPad if <code>true</code>, then whitespace and PAD are also allowed
+     * @param allowWSPad if {@code true}, then whitespace and PAD are also allowed
      *
-     * @return <code>true</code> if all bytes are valid characters in the alphabet or if the byte array is empty;
-     *         <code>false</code>, otherwise
+     * @return {@code true} if all bytes are valid characters in the alphabet or if the byte array is empty;
+     *         {@code false}, otherwise
      */
     public boolean isInAlphabet(final byte[] arrayOctet, final boolean allowWSPad) {
         for (final byte octet : arrayOctet) {
@@ -566,8 +566,8 @@ public boolean isInAlphabet(final byte[] arrayOctet, final boolean allowWSPad) {
      * The method treats whitespace and PAD as valid.
      *
      * @param basen String to test
-     * @return <code>true</code> if all characters in the String are valid characters in the alphabet or if
-     *         the String is empty; <code>false</code>, otherwise
+     * @return {@code true} if all characters in the String are valid characters in the alphabet or if
+     *         the String is empty; {@code false}, otherwise
      * @see #isInAlphabet(byte[], boolean)
      */
     public boolean isInAlphabet(final String basen) {
@@ -581,7 +581,7 @@ public boolean isInAlphabet(final String basen) {
      *
      * @param arrayOctet
      *            byte array to test
-     * @return <code>true</code> if any byte is a valid character in the alphabet or PAD; <code>false</code> otherwise
+     * @return {@code true} if any byte is a valid character in the alphabet or PAD; {@code false} otherwise
      */
     protected boolean containsAlphabetOrPad(final byte[] arrayOctet) {
         if (arrayOctet == null) {