This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git
The following commit(s) were added to refs/heads/master by this push:
new 1b7ca88 Javadoc: Replace <code></code> HTML tags with Javadoc {@code}
notation.
1b7ca88 is described below
commit 1b7ca880bef55ce8050e0b8dd5ead26f9a41950f
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Dec 9 22:27:23 2019 -0500
Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
---
.../org/apache/commons/codec/CharEncoding.java | 12 +--
.../java/org/apache/commons/codec/Charsets.java | 12 +--
.../org/apache/commons/codec/DecoderException.java | 10 +--
.../java/org/apache/commons/codec/Encoder.java | 2 +-
.../org/apache/commons/codec/EncoderException.java | 10 +--
.../commons/codec/StringEncoderComparator.java | 2 +-
.../org/apache/commons/codec/binary/Base32.java | 4 +-
.../org/apache/commons/codec/binary/Base64.java | 42 ++++-----
.../apache/commons/codec/binary/BaseNCodec.java | 30 +++----
.../codec/binary/BaseNCodecInputStream.java | 10 +--
.../codec/binary/BaseNCodecOutputStream.java | 4 +-
.../apache/commons/codec/binary/BinaryCodec.java | 4 +-
.../commons/codec/binary/CharSequenceUtils.java | 10 +--
.../java/org/apache/commons/codec/binary/Hex.java | 8 +-
.../apache/commons/codec/binary/StringUtils.java | 100 ++++++++++-----------
.../apache/commons/codec/digest/DigestUtils.java | 70 +++++++--------
.../org/apache/commons/codec/digest/HmacUtils.java | 14 +--
.../org/apache/commons/codec/digest/Sha2Crypt.java | 2 +-
.../commons/codec/language/AbstractCaverphone.java | 2 +-
.../apache/commons/codec/language/Caverphone.java | 2 +-
.../commons/codec/language/ColognePhonetic.java | 6 +-
.../commons/codec/language/DoubleMetaphone.java | 26 +++---
.../codec/language/MatchRatingApproachEncoder.java | 2 +-
.../apache/commons/codec/language/Metaphone.java | 4 +-
.../org/apache/commons/codec/language/Nysiis.java | 8 +-
.../org/apache/commons/codec/language/Soundex.java | 6 +-
.../codec/language/bm/BeiderMorseEncoder.java | 18 ++--
.../org/apache/commons/codec/language/bm/Lang.java | 2 +-
.../apache/commons/codec/language/bm/NameType.java | 2 +-
.../commons/codec/language/bm/PhoneticEngine.java | 16 ++--
.../org/apache/commons/codec/language/bm/Rule.java | 4 +-
.../java/org/apache/commons/codec/net/BCodec.java | 6 +-
.../java/org/apache/commons/codec/net/QCodec.java | 6 +-
.../commons/codec/net/QuotedPrintableCodec.java | 10 +--
.../org/apache/commons/codec/net/RFC1522Codec.java | 2 +-
.../org/apache/commons/codec/net/URLCodec.java | 4 +-
.../java/org/apache/commons/codec/net/Utils.java | 2 +-
.../codec/language/ColognePhoneticTest.java | 2 +-
38 files changed, 238 insertions(+), 238 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/CharEncoding.java
b/src/main/java/org/apache/commons/codec/CharEncoding.java
index cd74596..f82a728 100644
--- a/src/main/java/org/apache/commons/codec/CharEncoding.java
+++ b/src/main/java/org/apache/commons/codec/CharEncoding.java
@@ -29,17 +29,17 @@ package org.apache.commons.codec;
* </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>
diff --git a/src/main/java/org/apache/commons/codec/Charsets.java
b/src/main/java/org/apache/commons/codec/Charsets.java
index 44bb0bb..aad811a 100644
--- a/src/main/java/org/apache/commons/codec/Charsets.java
+++ b/src/main/java/org/apache/commons/codec/Charsets.java
@@ -30,17 +30,17 @@ import java.nio.charset.Charset;
* </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>
diff --git a/src/main/java/org/apache/commons/codec/DecoderException.java
b/src/main/java/org/apache/commons/codec/DecoderException.java
index 2b2fe07..c8fac41 100644
--- a/src/main/java/org/apache/commons/codec/DecoderException.java
+++ b/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 class DecoderException extends Exception {
/**
* 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 class DecoderException extends Exception {
/**
* 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
*/
diff --git a/src/main/java/org/apache/commons/codec/Encoder.java
b/src/main/java/org/apache/commons/codec/Encoder.java
index ddb652a..18168ec 100644
--- a/src/main/java/org/apache/commons/codec/Encoder.java
+++ b/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
diff --git a/src/main/java/org/apache/commons/codec/EncoderException.java
b/src/main/java/org/apache/commons/codec/EncoderException.java
index 27cefad..070e896 100644
--- a/src/main/java/org/apache/commons/codec/EncoderException.java
+++ b/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 class EncoderException extends Exception {
* 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 class EncoderException extends Exception {
/**
* 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
*/
diff --git
a/src/main/java/org/apache/commons/codec/StringEncoderComparator.java
b/src/main/java/org/apache/commons/codec/StringEncoderComparator.java
index 08e6399..fd23f13 100644
--- a/src/main/java/org/apache/commons/codec/StringEncoderComparator.java
+++ b/src/main/java/org/apache/commons/codec/StringEncoderComparator.java
@@ -61,7 +61,7 @@ public class StringEncoderComparator implements Comparator {
* 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
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java
b/src/main/java/org/apache/commons/codec/binary/Base32.java
index 7298801..af39ea6 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/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;
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java
b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 415f6fb..02bfa37 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/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 class Base64 extends BaseNCodec {
* </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 @@ public class Base64 extends BaseNCodec {
*
* @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 class Base64 extends BaseNCodec {
}
/**
- * 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 class Base64 extends BaseNCodec {
*
* @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 class Base64 extends BaseNCodec {
*
* @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 class Base64 extends BaseNCodec {
* @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 class Base64 extends BaseNCodec {
* @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 class Base64 extends BaseNCodec {
* @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 class Base64 extends BaseNCodec {
}
/**
- * 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 @@ public class Base64 extends BaseNCodec {
}
/**
- * 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) {
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index 3b40ad3..065f5ef 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -191,11 +191,11 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
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 > 0, use chunking with a length
<code>lineLength</code>
+ * @param lineLength if > 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 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
}
/**
- * 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 > 0, use chunking with a length
<code>lineLength</code>
+ * @param lineLength if > 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 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
}
/**
- * 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 abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
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 abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
* 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 abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* 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 abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
*
* @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) {
diff --git
a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
index 9d8f72d..567563c 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
@@ -49,8 +49,8 @@ public class BaseNCodecInputStream extends FilterInputStream {
/**
* {@inheritDoc}
*
- * @return <code>0</code> if the {@link InputStream} has reached
<code>EOF</code>,
- * <code>1</code> otherwise
+ * @return {@code 0} if the {@link InputStream} has reached {@code EOF},
+ * {@code 1} otherwise
* @since 1.7
*/
@Override
@@ -79,7 +79,7 @@ public class BaseNCodecInputStream extends FilterInputStream {
/**
* {@inheritDoc}
*
- * @return Always returns <code>false</code>
+ * @return Always returns {@code false}
*/
@Override
public boolean markSupported() {
@@ -87,7 +87,7 @@ public class BaseNCodecInputStream extends FilterInputStream {
}
/**
- * Reads one <code>byte</code> from this input stream.
+ * Reads one {@code byte} from this input stream.
*
* @return the byte as an integer in the range 0 to 255. Returns -1 if EOF
has been reached.
* @throws IOException
@@ -107,7 +107,7 @@ public class BaseNCodecInputStream extends
FilterInputStream {
}
/**
- * Attempts to read <code>len</code> bytes into the specified
<code>b</code> array starting at <code>offset</code>
+ * Attempts to read {@code len} bytes into the specified {@code b} array
starting at {@code offset}
* from this InputStream.
*
* @param b
diff --git
a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
index b598187..3b365a6 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
@@ -54,7 +54,7 @@ public class BaseNCodecOutputStream extends
FilterOutputStream {
}
/**
- * Writes the specified <code>byte</code> to this output stream.
+ * Writes the specified {@code byte} to this output stream.
*
* @param i
* source byte
@@ -68,7 +68,7 @@ public class BaseNCodecOutputStream extends
FilterOutputStream {
}
/**
- * Writes <code>len</code> bytes from the specified <code>b</code> array
starting at <code>offset</code> to this
+ * Writes {@code len} bytes from the specified {@code b} array starting at
{@code offset} to this
* output stream.
*
* @param b
diff --git a/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
b/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
index 02ef4eb..0c2389a 100644
--- a/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
@@ -215,11 +215,11 @@ public class BinaryCodec implements BinaryDecoder,
BinaryEncoder {
}
/**
- * Returns <code>true</code> if the given array is <code>null</code> or
empty (size 0.)
+ * Returns {@code true} if the given array is {@code null} or empty (size
0.)
*
* @param array
* the source array
- * @return <code>true</code> if the given array is <code>null</code> or
empty (size 0.)
+ * @return {@code true} if the given array is {@code null} or empty (size
0.)
*/
private static boolean isEmpty(final byte[] array) {
return array == null || array.length == 0;
diff --git
a/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
b/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
index 1239022..c3f37e8 100644
--- a/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
+++ b/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
@@ -18,7 +18,7 @@ package org.apache.commons.codec.binary;
/**
* <p>
- * Operations on {@link CharSequence} that are <code>null</code> safe.
+ * Operations on {@link CharSequence} that are {@code null} safe.
* </p>
* <p>
* Copied from Apache Commons Lang r1586295 on April 10, 2014 (day of 3.3.2
release).
@@ -33,15 +33,15 @@ public class CharSequenceUtils {
* Green implementation of regionMatches.
*
* @param cs
- * the <code>CharSequence</code> to be processed
+ * the {@code CharSequence} to be processed
* @param ignoreCase
* whether or not to be case insensitive
* @param thisStart
- * the index to start on the <code>cs</code> CharSequence
+ * the index to start on the {@code cs} CharSequence
* @param substring
- * the <code>CharSequence</code> to be looked for
+ * the {@code CharSequence} to be looked for
* @param start
- * the index to start on the <code>substring</code> CharSequence
+ * the index to start on the {@code substring} CharSequence
* @param length
* character length of the region
* @return whether the region matched
diff --git a/src/main/java/org/apache/commons/codec/binary/Hex.java
b/src/main/java/org/apache/commons/codec/binary/Hex.java
index dfbd64e..fa303e9 100644
--- a/src/main/java/org/apache/commons/codec/binary/Hex.java
+++ b/src/main/java/org/apache/commons/codec/binary/Hex.java
@@ -142,7 +142,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* given byte.
*
* @param data a byte[] to convert to Hex characters
- * @param toLowerCase <code>true</code> converts to lowercase,
<code>false</code> to uppercase
+ * @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase
* @return A char[] containing hexadecimal characters in the selected case
* @since 1.4
*/
@@ -159,7 +159,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* the value {@link ByteBuffer#remaining() remaining()} will be zero.</p>
*
* @param data a byte buffer to convert to Hex characters
- * @param toLowerCase <code>true</code> converts to lowercase,
<code>false</code> to uppercase
+ * @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase
* @return A char[] containing hexadecimal characters in the selected case
* @since 1.11
*/
@@ -224,7 +224,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* String will be double the length of the passed array, as it takes two
characters to represent any given byte.
*
* @param data a byte[] to convert to Hex characters
- * @param toLowerCase <code>true</code> converts to lowercase,
<code>false</code> to uppercase
+ * @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase
* @return A String containing lower-case hexadecimal characters
* @since 1.11
*/
@@ -255,7 +255,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* the value {@link ByteBuffer#remaining() remaining()} will be zero.</p>
*
* @param data a byte buffer to convert to Hex characters
- * @param toLowerCase <code>true</code> converts to lowercase,
<code>false</code> to uppercase
+ * @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase
* @return A String containing lower-case hexadecimal characters
* @since 1.11
*/
diff --git a/src/main/java/org/apache/commons/codec/binary/StringUtils.java
b/src/main/java/org/apache/commons/codec/binary/StringUtils.java
index 9aa984f..adb7ad8 100644
--- a/src/main/java/org/apache/commons/codec/binary/StringUtils.java
+++ b/src/main/java/org/apache/commons/codec/binary/StringUtils.java
@@ -39,11 +39,11 @@ public class StringUtils {
/**
* <p>
- * Compares two CharSequences, returning <code>true</code> if they
represent equal sequences of characters.
+ * Compares two CharSequences, returning {@code true} if they represent
equal sequences of characters.
* </p>
*
* <p>
- * <code>null</code>s are handled without exceptions. Two
<code>null</code> references are considered to be equal.
+ * {@code null}s are handled without exceptions. Two {@code null}
references are considered to be equal.
* The comparison is case sensitive.
* </p>
*
@@ -61,10 +61,10 @@ public class StringUtils {
*
* @see Object#equals(Object)
* @param cs1
- * the first CharSequence, may be <code>null</code>
+ * the first CharSequence, may be {@code null}
* @param cs2
- * the second CharSequence, may be <code>null</code>
- * @return <code>true</code> if the CharSequences are equal
(case-sensitive), or both <code>null</code>
+ * the second CharSequence, may be {@code null}
+ * @return {@code true} if the CharSequences are equal (case-sensitive),
or both {@code null}
* @since 1.10
*/
public static boolean equals(final CharSequence cs1, final CharSequence
cs2) {
@@ -86,7 +86,7 @@ public class StringUtils {
* @param string
* The string to encode (if null, return null).
* @param charset
- * The {@link Charset} to encode the <code>String</code>
+ * The {@link Charset} to encode the {@code String}
* @return the encoded bytes
*/
private static byte[] getBytes(final String string, final Charset charset)
{
@@ -102,7 +102,7 @@ public class StringUtils {
* @param string
* The string to encode (if null, return null).
* @param charset
- * The {@link Charset} to encode the <code>String</code>
+ * The {@link Charset} to encode the {@code String}
* @return the encoded bytes
*/
private static ByteBuffer getByteBuffer(final String string, final Charset
charset) {
@@ -117,8 +117,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be <code>null</code>
- * @return encoded bytes, or <code>null</code> if the input string was
<code>null</code>
+ * the String to encode, may be {@code null}
+ * @return encoded bytes, or {@code null} if the input string was {@code
null}
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_8} is not initialized, which
should never happen since it is
* required by the Java platform specification.
@@ -135,8 +135,8 @@ public class StringUtils {
* byte array.
*
* @param string
- * the String to encode, may be <code>null</code>
- * @return encoded bytes, or <code>null</code> if the input string was
<code>null</code>
+ * the String to encode, may be {@code null}
+ * @return encoded bytes, or {@code null} if the input string was {@code
null}
* @throws NullPointerException
* Thrown if {@link Charsets#ISO_8859_1} is not initialized,
which should never happen since it is
* required by the Java platform specification.
@@ -158,10 +158,10 @@ public class StringUtils {
* </p>
*
* @param string
- * the String to encode, may be <code>null</code>
+ * the String to encode, may be {@code null}
* @param charsetName
* The name of a required {@link java.nio.charset.Charset}
- * @return encoded bytes, or <code>null</code> if the input string was
<code>null</code>
+ * @return encoded bytes, or {@code null} if the input string was {@code
null}
* @throws IllegalStateException
* Thrown when a {@link UnsupportedEncodingException} is
caught, which should never happen for a
* required charset name.
@@ -184,8 +184,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be <code>null</code>
- * @return encoded bytes, or <code>null</code> if the input string was
<code>null</code>
+ * the String to encode, may be {@code null}
+ * @return encoded bytes, or {@code null} if the input string was {@code
null}
* @throws NullPointerException
* Thrown if {@link Charsets#US_ASCII} is not initialized,
which should never happen since it is
* required by the Java platform specification.
@@ -202,8 +202,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be <code>null</code>
- * @return encoded bytes, or <code>null</code> if the input string was
<code>null</code>
+ * the String to encode, may be {@code null}
+ * @return encoded bytes, or {@code null} if the input string was {@code
null}
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16} is not initialized, which
should never happen since it is
* required by the Java platform specification.
@@ -220,8 +220,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be <code>null</code>
- * @return encoded bytes, or <code>null</code> if the input string was
<code>null</code>
+ * the String to encode, may be {@code null}
+ * @return encoded bytes, or {@code null} if the input string was {@code
null}
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16BE} is not initialized,
which should never happen since it is
* required by the Java platform specification.
@@ -238,8 +238,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be <code>null</code>
- * @return encoded bytes, or <code>null</code> if the input string was
<code>null</code>
+ * the String to encode, may be {@code null}
+ * @return encoded bytes, or {@code null} if the input string was {@code
null}
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16LE} is not initialized,
which should never happen since it is
* required by the Java platform specification.
@@ -256,8 +256,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be <code>null</code>
- * @return encoded bytes, or <code>null</code> if the input string was
<code>null</code>
+ * the String to encode, may be {@code null}
+ * @return encoded bytes, or {@code null} if the input string was {@code
null}
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_8} is not initialized, which
should never happen since it is
* required by the Java platform specification.
@@ -275,14 +275,14 @@ public class StringUtils {
}
/**
- * Constructs a new <code>String</code> by decoding the specified array of
bytes using the given charset.
+ * Constructs a new {@code String} by decoding the specified array of
bytes using the given charset.
*
* @param bytes
* The bytes to be decoded into characters
* @param charset
- * The {@link Charset} to encode the <code>String</code>; not
{@code null}
- * @return A new <code>String</code> decoded from the specified array of
bytes using the given charset,
- * or <code>null</code> if the input byte array was
<code>null</code>.
+ * The {@link Charset} to encode the {@code String}; not {@code
null}
+ * @return A new {@code String} decoded from the specified array of bytes
using the given charset,
+ * or {@code null} if the input byte array was {@code null}.
* @throws NullPointerException
* Thrown if charset is {@code null}
*/
@@ -291,18 +291,18 @@ public class StringUtils {
}
/**
- * Constructs a new <code>String</code> by decoding the specified array of
bytes using the given charset.
+ * Constructs a new {@code String} by decoding the specified array of
bytes using the given charset.
* <p>
* This method catches {@link UnsupportedEncodingException} and re-throws
it as {@link IllegalStateException}, which
* should never happen for a required charset name. Use this method when
the encoding is required to be in the JRE.
* </p>
*
* @param bytes
- * The bytes to be decoded into characters, may be
<code>null</code>
+ * The bytes to be decoded into characters, may be {@code null}
* @param charsetName
* The name of a required {@link java.nio.charset.Charset}
- * @return A new <code>String</code> decoded from the specified array of
bytes using the given charset,
- * or <code>null</code> if the input byte array was
<code>null</code>.
+ * @return A new {@code String} decoded from the specified array of bytes
using the given charset,
+ * or {@code null} if the input byte array was {@code null}.
* @throws IllegalStateException
* Thrown when a {@link UnsupportedEncodingException} is
caught, which should never happen for a
* required charset name.
@@ -321,12 +321,12 @@ public class StringUtils {
}
/**
- * Constructs a new <code>String</code> by decoding the specified array of
bytes using the ISO-8859-1 charset.
+ * Constructs a new {@code String} by decoding the specified array of
bytes using the ISO-8859-1 charset.
*
* @param bytes
- * The bytes to be decoded into characters, may be
<code>null</code>
- * @return A new <code>String</code> decoded from the specified array of
bytes using the ISO-8859-1 charset, or
- * <code>null</code> if the input byte array was <code>null</code>.
+ * The bytes to be decoded into characters, may be {@code null}
+ * @return A new {@code String} decoded from the specified array of bytes
using the ISO-8859-1 charset, or
+ * {@code null} if the input byte array was {@code null}.
* @throws NullPointerException
* Thrown if {@link Charsets#ISO_8859_1} is not initialized,
which should never happen since it is
* required by the Java platform specification.
@@ -337,12 +337,12 @@ public class StringUtils {
}
/**
- * Constructs a new <code>String</code> by decoding the specified array of
bytes using the US-ASCII charset.
+ * Constructs a new {@code String} by decoding the specified array of
bytes using the US-ASCII charset.
*
* @param bytes
* The bytes to be decoded into characters
- * @return A new <code>String</code> decoded from the specified array of
bytes using the US-ASCII charset,
- * or <code>null</code> if the input byte array was
<code>null</code>.
+ * @return A new {@code String} decoded from the specified array of bytes
using the US-ASCII charset,
+ * or {@code null} if the input byte array was {@code null}.
* @throws NullPointerException
* Thrown if {@link Charsets#US_ASCII} is not initialized,
which should never happen since it is
* required by the Java platform specification.
@@ -353,12 +353,12 @@ public class StringUtils {
}
/**
- * Constructs a new <code>String</code> by decoding the specified array of
bytes using the UTF-16 charset.
+ * Constructs a new {@code String} by decoding the specified array of
bytes using the UTF-16 charset.
*
* @param bytes
* The bytes to be decoded into characters
- * @return A new <code>String</code> decoded from the specified array of
bytes using the UTF-16 charset
- * or <code>null</code> if the input byte array was
<code>null</code>.
+ * @return A new {@code String} decoded from the specified array of bytes
using the UTF-16 charset
+ * or {@code null} if the input byte array was {@code null}.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16} is not initialized, which
should never happen since it is
* required by the Java platform specification.
@@ -369,12 +369,12 @@ public class StringUtils {
}
/**
- * Constructs a new <code>String</code> by decoding the specified array of
bytes using the UTF-16BE charset.
+ * Constructs a new {@code String} by decoding the specified array of
bytes using the UTF-16BE charset.
*
* @param bytes
* The bytes to be decoded into characters
- * @return A new <code>String</code> decoded from the specified array of
bytes using the UTF-16BE charset,
- * or <code>null</code> if the input byte array was
<code>null</code>.
+ * @return A new {@code String} decoded from the specified array of bytes
using the UTF-16BE charset,
+ * or {@code null} if the input byte array was {@code null}.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16BE} is not initialized,
which should never happen since it is
* required by the Java platform specification.
@@ -385,12 +385,12 @@ public class StringUtils {
}
/**
- * Constructs a new <code>String</code> by decoding the specified array of
bytes using the UTF-16LE charset.
+ * Constructs a new {@code String} by decoding the specified array of
bytes using the UTF-16LE charset.
*
* @param bytes
* The bytes to be decoded into characters
- * @return A new <code>String</code> decoded from the specified array of
bytes using the UTF-16LE charset,
- * or <code>null</code> if the input byte array was
<code>null</code>.
+ * @return A new {@code String} decoded from the specified array of bytes
using the UTF-16LE charset,
+ * or {@code null} if the input byte array was {@code null}.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16LE} is not initialized,
which should never happen since it is
* required by the Java platform specification.
@@ -401,12 +401,12 @@ public class StringUtils {
}
/**
- * Constructs a new <code>String</code> by decoding the specified array of
bytes using the UTF-8 charset.
+ * Constructs a new {@code String} by decoding the specified array of
bytes using the UTF-8 charset.
*
* @param bytes
* The bytes to be decoded into characters
- * @return A new <code>String</code> decoded from the specified array of
bytes using the UTF-8 charset,
- * or <code>null</code> if the input byte array was
<code>null</code>.
+ * @return A new {@code String} decoded from the specified array of bytes
using the UTF-8 charset,
+ * or {@code null} if the input byte array was {@code null}.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_8} is not initialized, which
should never happen since it is
* required by the Java platform specification.
diff --git a/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
b/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
index 17f0e89..8a60516 100644
--- a/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
+++ b/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
@@ -131,7 +131,7 @@ public class DigestUtils {
}
/**
- * Returns a <code>MessageDigest</code> for the given
<code>algorithm</code>.
+ * Returns a {@code MessageDigest} for the given {@code algorithm}.
*
* @param algorithm
* the name of the algorithm requested. See <a
@@ -152,7 +152,7 @@ public class DigestUtils {
}
/**
- * Returns a <code>MessageDigest</code> for the given
<code>algorithm</code> or a default if there is a problem
+ * Returns a {@code MessageDigest} for the given {@code algorithm} or a
default if there is a problem
* getting the algorithm.
*
* @param algorithm
@@ -336,7 +336,7 @@ public class DigestUtils {
}
/**
- * Calculates the MD2 digest and returns the value as a 16 element
<code>byte[]</code>.
+ * Calculates the MD2 digest and returns the value as a 16 element {@code
byte[]}.
*
* @param data
* Data to digest
@@ -348,7 +348,7 @@ public class DigestUtils {
}
/**
- * Calculates the MD2 digest and returns the value as a 16 element
<code>byte[]</code>.
+ * Calculates the MD2 digest and returns the value as a 16 element {@code
byte[]}.
*
* @param data
* Data to digest
@@ -362,7 +362,7 @@ public class DigestUtils {
}
/**
- * Calculates the MD2 digest and returns the value as a 16 element
<code>byte[]</code>.
+ * Calculates the MD2 digest and returns the value as a 16 element {@code
byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -412,7 +412,7 @@ public class DigestUtils {
}
/**
- * Calculates the MD5 digest and returns the value as a 16 element
<code>byte[]</code>.
+ * Calculates the MD5 digest and returns the value as a 16 element {@code
byte[]}.
*
* @param data
* Data to digest
@@ -423,7 +423,7 @@ public class DigestUtils {
}
/**
- * Calculates the MD5 digest and returns the value as a 16 element
<code>byte[]</code>.
+ * Calculates the MD5 digest and returns the value as a 16 element {@code
byte[]}.
*
* @param data
* Data to digest
@@ -437,7 +437,7 @@ public class DigestUtils {
}
/**
- * Calculates the MD5 digest and returns the value as a 16 element
<code>byte[]</code>.
+ * Calculates the MD5 digest and returns the value as a 16 element {@code
byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -484,7 +484,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-1 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-1 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -497,7 +497,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-1 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-1 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -513,7 +513,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-1 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-1 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -526,7 +526,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-1 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-1 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -538,7 +538,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-1 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-1 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -552,7 +552,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-1 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-1 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -601,7 +601,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-256 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-256 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -613,7 +613,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-256 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-256 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -627,7 +627,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-256 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-256 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -677,7 +677,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-224 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-224 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest
@@ -689,7 +689,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-224 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-224 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest
@@ -703,7 +703,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-224 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-224 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -753,7 +753,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-256 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-256 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest
@@ -765,7 +765,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-256 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-256 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest
@@ -779,7 +779,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-256 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-256 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -829,7 +829,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-384 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-384 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest
@@ -841,7 +841,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-384 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-384 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest
@@ -855,7 +855,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-384 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-384 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -905,7 +905,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-512 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-512 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest
@@ -917,7 +917,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-512 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-512 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest
@@ -931,7 +931,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA3-512 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA3-512 digest and returns the value as a {@code
byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -981,7 +981,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-384 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-384 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -993,7 +993,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-384 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-384 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -1007,7 +1007,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-384 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-384 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
@@ -1057,7 +1057,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-512 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-512 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -1069,7 +1069,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-512 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-512 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest
@@ -1083,7 +1083,7 @@ public class DigestUtils {
}
/**
- * Calculates the SHA-512 digest and returns the value as a
<code>byte[]</code>.
+ * Calculates the SHA-512 digest and returns the value as a {@code byte[]}.
*
* @param data
* Data to digest; converted to bytes using {@link
StringUtils#getBytesUtf8(String)}
diff --git a/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
b/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
index 5a31ac5..ae244d9 100644
--- a/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
+++ b/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
@@ -90,7 +90,7 @@ public final class HmacUtils {
}
/**
- * Returns an initialized <code>Mac</code> for the HmacMD5 algorithm.
+ * Returns an initialized {@code Mac} for the HmacMD5 algorithm.
* <p>
* Every implementation of the Java platform is required to support this
standard Mac algorithm.
* </p>
@@ -110,7 +110,7 @@ public final class HmacUtils {
}
/**
- * Returns an initialized <code>Mac</code> for the HmacSHA1 algorithm.
+ * Returns an initialized {@code Mac} for the HmacSHA1 algorithm.
* <p>
* Every implementation of the Java platform is required to support this
standard Mac algorithm.
* </p>
@@ -130,7 +130,7 @@ public final class HmacUtils {
}
/**
- * Returns an initialized <code>Mac</code> for the HmacSHA256 algorithm.
+ * Returns an initialized {@code Mac} for the HmacSHA256 algorithm.
* <p>
* Every implementation of the Java platform is required to support this
standard Mac algorithm.
* </p>
@@ -150,7 +150,7 @@ public final class HmacUtils {
}
/**
- * Returns an initialized <code>Mac</code> for the HmacSHA384 algorithm.
+ * Returns an initialized {@code Mac} for the HmacSHA384 algorithm.
* <p>
* Every implementation of the Java platform is <em>not</em> required to
support this Mac algorithm.
* </p>
@@ -170,7 +170,7 @@ public final class HmacUtils {
}
/**
- * Returns an initialized <code>Mac</code> for the HmacSHA512 algorithm.
+ * Returns an initialized {@code Mac} for the HmacSHA512 algorithm.
* <p>
* Every implementation of the Java platform is <em>not</em> required to
support this Mac algorithm.
* </p>
@@ -190,7 +190,7 @@ public final class HmacUtils {
}
/**
- * Returns an initialized <code>Mac</code> for the given
<code>algorithm</code>.
+ * Returns an initialized {@code Mac} for the given {@code algorithm}.
*
* @param algorithm
* the name of the algorithm requested. See
@@ -210,7 +210,7 @@ public final class HmacUtils {
}
/**
- * Returns an initialized <code>Mac</code> for the given
<code>algorithm</code>.
+ * Returns an initialized {@code Mac} for the given {@code algorithm}.
*
* @param algorithm
* the name of the algorithm requested. See
diff --git a/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
b/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
index f49505a..1b8eb14 100644
--- a/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
@@ -160,7 +160,7 @@ public class Sha2Crypt {
* {@link MessageDigest} algorithm identifier string
* @return complete hash value including prefix and salt
* @throws IllegalArgumentException
- * if the given salt is <code>null</code> or does not match
the allowed pattern
+ * if the given salt is {@code null} or does not match the
allowed pattern
* @throws IllegalArgumentException
* when a {@link NoSuchAlgorithmException} is caught
* @see MessageDigestAlgorithms
diff --git
a/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
b/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
index 90979da..734c0e7 100644
--- a/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
+++ b/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
@@ -68,7 +68,7 @@ public abstract class AbstractCaverphone implements
StringEncoder {
* First of two strings to compare
* @param str2
* Second of two strings to compare
- * @return <code>true</code> if the encodings of these strings are
identical, <code>false</code> otherwise.
+ * @return {@code true} if the encodings of these strings are identical,
{@code false} otherwise.
* @throws EncoderException
* thrown if there is an error condition during the encoding
process.
*/
diff --git a/src/main/java/org/apache/commons/codec/language/Caverphone.java
b/src/main/java/org/apache/commons/codec/language/Caverphone.java
index 1f5d0c5..4041f83 100644
--- a/src/main/java/org/apache/commons/codec/language/Caverphone.java
+++ b/src/main/java/org/apache/commons/codec/language/Caverphone.java
@@ -95,7 +95,7 @@ public class Caverphone implements StringEncoder {
* First of two strings to compare
* @param str2
* Second of two strings to compare
- * @return <code>true</code> if the caverphones of these strings are
identical, <code>false</code> otherwise.
+ * @return {@code true} if the caverphones of these strings are identical,
{@code false} otherwise.
*/
public boolean isCaverphoneEqual(final String str1, final String str2) {
return this.caverphone(str1).equals(this.caverphone(str2));
diff --git
a/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
b/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
index 2ce2e51..4b0ecf0 100644
--- a/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
+++ b/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
@@ -151,7 +151,7 @@ import org.apache.commons.codec.StringEncoder;
*
* <h4>Example:</h4>
*
- * <code>"M</code>ü<code>ller-L</code>ü<code>denscheidt"
+ * {@code "M}ü{@code ller-L}ü<code>denscheidt"
* => "MULLERLUDENSCHEIDT" => "6005507500206880022"</code>
*
* </li>
@@ -160,7 +160,7 @@ import org.apache.commons.codec.StringEncoder;
* <h3>Step 2:</h3>
* Collapse of all multiple consecutive code digits.
* <h4>Example:</h4>
- * <code>"6005507500206880022" => "6050750206802"</code></li>
+ * {@code "6005507500206880022" => "6050750206802"}</li>
*
* <li>
* <h3>Step 3:</h3>
@@ -168,7 +168,7 @@ import org.apache.commons.codec.StringEncoder;
* if they occur after removing the "0" digits.
*
* <h4>Example:</h4>
- * <code>"6050750206802" => "65752682"</code></li>
+ * {@code "6050750206802" => "65752682"}</li>
*
* </ul>
*
diff --git
a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
index 0d8640b..3013c93 100644
--- a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
@@ -191,7 +191,7 @@ public class DoubleMetaphone implements StringEncoder {
/**
* Encode the value using DoubleMetaphone. It will only work if
- * <code>obj</code> is a <code>String</code> (like <code>Metaphone</code>).
+ * {@code obj} is a {@code String} (like {@code Metaphone}).
*
* @param obj Object to encode (should be of type String)
* @return An encoded Object (will be of type String)
@@ -217,13 +217,13 @@ public class DoubleMetaphone implements StringEncoder {
}
/**
- * Check if the Double Metaphone values of two <code>String</code> values
+ * Check if the Double Metaphone values of two {@code String} values
* are equal.
*
* @param value1 The left-hand side of the encoded {@link
String#equals(Object)}.
* @param value2 The right-hand side of the encoded {@link
String#equals(Object)}.
- * @return <code>true</code> if the encoded <code>String</code>s are equal;
- * <code>false</code> otherwise.
+ * @return {@code true} if the encoded {@code String}s are equal;
+ * {@code false} otherwise.
* @see #isDoubleMetaphoneEqual(String,String,boolean)
*/
public boolean isDoubleMetaphoneEqual(final String value1, final String
value2) {
@@ -231,14 +231,14 @@ public class DoubleMetaphone implements StringEncoder {
}
/**
- * Check if the Double Metaphone values of two <code>String</code> values
+ * Check if the Double Metaphone values of two {@code String} values
* are equal, optionally using the alternate value.
*
* @param value1 The left-hand side of the encoded {@link
String#equals(Object)}.
* @param value2 The right-hand side of the encoded {@link
String#equals(Object)}.
- * @param alternate use the alternate value if <code>true</code>.
- * @return <code>true</code> if the encoded <code>String</code>s are equal;
- * <code>false</code> otherwise.
+ * @param alternate use the alternate value if {@code true}.
+ * @return {@code true} if the encoded {@code String}s are equal;
+ * {@code false} otherwise.
*/
public boolean isDoubleMetaphoneEqual(final String value1, final String
value2, final boolean alternate) {
return StringUtils.equals(doubleMetaphone(value1, alternate),
doubleMetaphone(value2, alternate));
@@ -867,7 +867,7 @@ public class DoubleMetaphone implements StringEncoder {
/**
* Determines whether or not the value starts with a silent letter. It
will
- * return <code>true</code> if the value starts with any of 'GN', 'KN',
+ * return {@code true} if the value starts with any of 'GN', 'KN',
* 'PN', 'WR' or 'PS'.
*/
private boolean isSilentStart(final String value) {
@@ -896,8 +896,8 @@ public class DoubleMetaphone implements StringEncoder {
}
/*
- * Gets the character at index <code>index</code> if available, otherwise
- * it returns <code>Character.MIN_VALUE</code> so that there is some sort
+ * Gets the character at index {@code index} if available, otherwise
+ * it returns {@code Character.MIN_VALUE} so that there is some sort
* of a default.
*/
protected char charAt(final String value, final int index) {
@@ -908,8 +908,8 @@ public class DoubleMetaphone implements StringEncoder {
}
/*
- * Determines whether <code>value</code> contains any of the criteria
starting at index <code>start</code> and
- * matching up to length <code>length</code>.
+ * Determines whether {@code value} contains any of the criteria starting
at index {@code start} and
+ * matching up to length {@code length}.
*/
protected static boolean contains(final String value, final int start,
final int length,
final String... criteria) {
diff --git
a/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
b/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
index e6c1e44..be9647a 100644
---
a/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
+++
b/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
@@ -206,7 +206,7 @@ public class MatchRatingApproachEncoder implements
StringEncoder {
* First of the 2 strings (names) to compare
* @param name2
* Second of the 2 names to compare
- * @return <code>true</code> if the encodings are identical
<code>false</code> otherwise.
+ * @return {@code true} if the encodings are identical {@code false}
otherwise.
*/
public boolean isEncodeEquals(String name1, String name2) {
// Bulletproof for trivial input - NINO
diff --git a/src/main/java/org/apache/commons/codec/language/Metaphone.java
b/src/main/java/org/apache/commons/codec/language/Metaphone.java
index b38a518..f4c53e5 100644
--- a/src/main/java/org/apache/commons/codec/language/Metaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/Metaphone.java
@@ -407,8 +407,8 @@ public class Metaphone implements StringEncoder {
*
* @param str1 First of two strings to compare
* @param str2 Second of two strings to compare
- * @return <code>true</code> if the metaphones of these strings are
identical,
- * <code>false</code> otherwise.
+ * @return {@code true} if the metaphones of these strings are identical,
+ * {@code false} otherwise.
*/
public boolean isMetaphoneEqual(final String str1, final String str2) {
return metaphone(str1).equals(metaphone(str2));
diff --git a/src/main/java/org/apache/commons/codec/language/Nysiis.java
b/src/main/java/org/apache/commons/codec/language/Nysiis.java
index 54008d8..28ae275 100644
--- a/src/main/java/org/apache/commons/codec/language/Nysiis.java
+++ b/src/main/java/org/apache/commons/codec/language/Nysiis.java
@@ -94,7 +94,7 @@ public class Nysiis implements StringEncoder {
*
* @param c
* the character to test
- * @return <code>true</code> if the character is a vowel,
<code>false</code> otherwise
+ * @return {@code true} if the character is a vowel, {@code false}
otherwise
*/
private static boolean isVowel(final char c) {
return c == 'A' || c == 'E' || c == 'I' || c == 'O' || c == 'U';
@@ -180,8 +180,8 @@ public class Nysiis implements StringEncoder {
* Create an instance of the {@link Nysiis} encoder with the specified
strict mode:
*
* <ul>
- * <li><code>true</code>: encoded strings have a maximum length of 6</li>
- * <li><code>false</code>: encoded strings may have arbitrary length</li>
+ * <li>{@code true}: encoded strings have a maximum length of 6</li>
+ * <li>{@code false}: encoded strings may have arbitrary length</li>
* </ul>
*
* @param strict
@@ -229,7 +229,7 @@ public class Nysiis implements StringEncoder {
/**
* Indicates the strict mode for this {@link Nysiis} encoder.
*
- * @return <code>true</code> if the encoder is configured for strict mode,
<code>false</code> otherwise
+ * @return {@code true} if the encoder is configured for strict mode,
{@code false} otherwise
*/
public boolean isStrict() {
return this.strict;
diff --git a/src/main/java/org/apache/commons/codec/language/Soundex.java
b/src/main/java/org/apache/commons/codec/language/Soundex.java
index 0a4b767..6acdac2 100644
--- a/src/main/java/org/apache/commons/codec/language/Soundex.java
+++ b/src/main/java/org/apache/commons/codec/language/Soundex.java
@@ -43,7 +43,7 @@ public class Soundex implements StringEncoder {
public static final char SILENT_MARKER = '-';
/**
- * This is a default mapping of the 26 letters used in US English. A value
of <code>0</code> for a letter position
+ * This is a default mapping of the 26 letters used in US English. A value
of {@code 0} for a letter position
* means do not encode, but treat as a separator when it occurs between
consonants with the same code.
* <p>
* (This constant is provided as both an implementation convenience and to
allow Javadoc to pick
@@ -57,7 +57,7 @@ public class Soundex implements StringEncoder {
public static final String US_ENGLISH_MAPPING_STRING =
"01230120022455012623010202";
/**
- * This is a default mapping of the 26 letters used in US English. A value
of <code>0</code> for a letter position
+ * This is a default mapping of the 26 letters used in US English. A value
of {@code 0} for a letter position
* means do not encode.
*
* @see Soundex#Soundex(char[])
@@ -269,7 +269,7 @@ public class Soundex implements StringEncoder {
* An upper-case character.
* @return A Soundex code.
* @throws IllegalArgumentException
- * Thrown if <code>ch</code> is not mapped.
+ * Thrown if {@code ch} is not mapped.
*/
private char map(final char ch) {
final int index = ch - 'A';
diff --git
a/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
b/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
index 737a976..03fcb39 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
@@ -33,7 +33,7 @@ import org.apache.commons.codec.StringEncoder;
* <b>Encoding overview</b>
* <p>
* Beider-Morse phonetic encodings is a multi-step process. Firstly, a table
of rules is consulted to guess what
- * language the word comes from. For example, if it ends in
"<code>ault</code>" then it infers that the word is French.
+ * language the word comes from. For example, if it ends in "{@code ault}"
then it infers that the word is French.
* Next, the word is translated into a phonetic representation using a
language-specific phonetics table. Some runs of
* letters can be pronounced in multiple ways, and a single run of letters may
be potentially broken up into phonemes at
* different places, so this stage results in a set of possible
language-specific phonetic representations. Lastly, this
@@ -45,25 +45,25 @@ import org.apache.commons.codec.StringEncoder;
* <p>
* Some names are treated as having multiple parts. This can be due to two
things. Firstly, they may be hyphenated. In
* this case, each individual hyphenated word is encoded, and then these are
combined end-to-end for the final encoding.
- * Secondly, some names have standard prefixes, for example,
"<code>Mac/Mc</code>" in Scottish (English) names. As
+ * Secondly, some names have standard prefixes, for example, "{@code Mac/Mc}"
in Scottish (English) names. As
* sometimes it is ambiguous whether the prefix is intended or is an accident
of the spelling, the word is encoded once
* with the prefix and once without it. The resulting encoding contains one
and then the other result.
* <p>
* <b>Encoding format</b>
* <p>
* Individual phonetic spellings of an input word are represented in upper-
and lower-case roman characters. Where there
- * are multiple possible phonetic representations, these are joined with a
pipe (<code>|</code>) character. If multiple
+ * are multiple possible phonetic representations, these are joined with a
pipe ({@code |}) character. If multiple
* hyphenated words where found, or if the word may contain a name prefix,
each encoded word is placed in elipses and
- * these blocks are then joined with hyphens. For example,
"<code>d'ortley</code>" has a possible prefix. The form
- * without prefix encodes to "<code>ortlaj|ortlej</code>", while the form with
prefix encodes to "
- * <code>dortlaj|dortlej</code>". Thus, the full, combined encoding is
"<code>(ortlaj|ortlej)-(dortlaj|dortlej)</code>".
+ * these blocks are then joined with hyphens. For example, "{@code d'ortley}"
has a possible prefix. The form
+ * without prefix encodes to "{@code ortlaj|ortlej}", while the form with
prefix encodes to "
+ * {@code dortlaj|dortlej}". Thus, the full, combined encoding is "{@code
(ortlaj|ortlej)-(dortlaj|dortlej)}".
* <p>
* The encoded forms are often quite a bit longer than the input strings. This
is because a single input may have many
- * potential phonetic interpretations. For example, "<code>Renault</code>"
encodes to "
- * <code>rYnDlt|rYnalt|rYnult|rinDlt|rinalt|rinult</code>". The
<code>APPROX</code> rules will tend to produce larger
+ * potential phonetic interpretations. For example, "{@code Renault}" encodes
to "
+ * {@code rYnDlt|rYnalt|rYnult|rinDlt|rinalt|rinult}". The {@code APPROX}
rules will tend to produce larger
* encodings as they consider a wider range of possible, approximate phonetic
interpretations of the original word.
* Down-stream applications may wish to further process the encoding for
indexing or lookup purposes, for example, by
- * splitting on pipe (<code>|</code>) and indexing under each of these
alternatives.
+ * splitting on pipe ({@code |}) and indexing under each of these alternatives.
* <p>
* <b>Note</b>: this version of the Beider-Morse encoding is equivalent with
v3.4 of the reference implementation.
* </p>
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Lang.java
b/src/main/java/org/apache/commons/codec/language/bm/Lang.java
index 31f25d3..e2559ed 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/Lang.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/Lang.java
@@ -75,7 +75,7 @@ public class Lang {
//
// It may make sense in the future to expose the private constructor to
allow power users to build custom language-
// guessing rules, perhaps by marking it protected and allowing
sub-classing. However, the vast majority of users
- // should be strongly encouraged to use the static factory
<code>instance</code> method to get their Lang instances.
+ // should be strongly encouraged to use the static factory {@code
instance} method to get their Lang instances.
private static final class LangRule {
private final boolean acceptOnMatch;
diff --git a/src/main/java/org/apache/commons/codec/language/bm/NameType.java
b/src/main/java/org/apache/commons/codec/language/bm/NameType.java
index 4a7a587..df3d5f5 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/NameType.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/NameType.java
@@ -19,7 +19,7 @@ package org.apache.commons.codec.language.bm;
/**
* Supported types of names. Unless you are matching particular family names,
use {@link #GENERIC}. The
- * <code>GENERIC</code> NameType should work reasonably well for non-name
words. The other encodings are
+ * {@code GENERIC} NameType should work reasonably well for non-name words.
The other encodings are
* specifically tuned to family names, and may not work well at all for
general text.
*
* @since 1.6
diff --git
a/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
b/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
index efc3053..1f2c78d 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
@@ -83,7 +83,7 @@ public class PhoneticEngine {
}
/**
- * Creates a new phoneme builder containing all phonemes in this one
extended by <code>str</code>.
+ * Creates a new phoneme builder containing all phonemes in this one
extended by {@code str}.
*
* @param str the characters to append to the phonemes
*/
@@ -156,10 +156,10 @@ public class PhoneticEngine {
/**
* A function closure capturing the application of a list of rules to an
input sequence at a particular offset.
- * After invocation, the values <code>i</code> and <code>found</code> are
updated. <code>i</code> points to the
- * index of the next char in <code>input</code> that must be processed
next (the input up to that index having been
- * processed already), and <code>found</code> indicates if a matching rule
was found or not. In the case where a
- * matching rule was found, <code>phonemeBuilder</code> is replaced with a
new builder containing the phonemes
+ * After invocation, the values {@code i} and {@code found} are updated.
{@code i} points to the
+ * index of the next char in {@code input} that must be processed next
(the input up to that index having been
+ * processed already), and {@code found} indicates if a matching rule was
found or not. In the case where a
+ * matching rule was found, {@code phonemeBuilder} is replaced with a new
builder containing the phonemes
* updated by the matching rule.
*
* Although this class is not thread-safe (it has mutable unprotected
fields), it is not shared between threads
@@ -198,9 +198,9 @@ public class PhoneticEngine {
/**
* Invokes the rules. Loops over the rules list, stopping at the first
one that has a matching context
* and pattern. Then applies this rule to the phoneme builder to
produce updated phonemes. If there was no
- * match, <code>i</code> is advanced one and the character is silently
dropped from the phonetic spelling.
+ * match, {@code i} is advanced one and the character is silently
dropped from the phonetic spelling.
*
- * @return <code>this</code>
+ * @return {@code this}
*/
public RulesApplication invoke() {
this.found = false;
@@ -251,7 +251,7 @@ public class PhoneticEngine {
* Joins some strings with an internal separator.
* @param strings Strings to join
* @param sep String to separate them with
- * @return a single String consisting of each element of
<code>strings</code> interleaved by <code>sep</code>
+ * @return a single String consisting of each element of {@code strings}
interleaved by {@code sep}
*/
private static String join(final Iterable<String> strings, final String
sep) {
final StringBuilder sb = new StringBuilder();
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Rule.java
b/src/main/java/org/apache/commons/codec/language/bm/Rule.java
index fe8014b..644614a 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/Rule.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/Rule.java
@@ -672,8 +672,8 @@ public class Rule {
/**
* Decides if the pattern and context match the input starting at a
position. It is a match if the
- * <code>lContext</code> matches <code>input</code> up to <code>i</code>,
<code>pattern</code> matches at i and
- * <code>rContext</code> matches from the end of the match of
<code>pattern</code> to the end of <code>input</code>.
+ * {@code lContext} matches {@code input} up to {@code i}, {@code pattern}
matches at i and
+ * {@code rContext} matches from the end of the match of {@code pattern}
to the end of {@code input}.
*
* @param input
* the input String
diff --git a/src/main/java/org/apache/commons/codec/net/BCodec.java
b/src/main/java/org/apache/commons/codec/net/BCodec.java
index cdaedee..dade5e7 100644
--- a/src/main/java/org/apache/commons/codec/net/BCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/BCodec.java
@@ -109,7 +109,7 @@ public class BCodec extends RFC1522Codec implements
StringEncoder, StringDecoder
* @param strSource
* string to convert to Base64 form
* @param sourceCharset
- * the Charset for <code>value</code>
+ * the Charset for {@code value}
* @return Base64 string
* @throws EncoderException
* thrown if a failure condition is encountered during the
encoding process.
@@ -128,7 +128,7 @@ public class BCodec extends RFC1522Codec implements
StringEncoder, StringDecoder
* @param strSource
* string to convert to Base64 form
* @param sourceCharset
- * the Charset for <code>value</code>
+ * the Charset for {@code value}
* @return Base64 string
* @throws EncoderException
* thrown if a failure condition is encountered during the
encoding process.
@@ -213,7 +213,7 @@ public class BCodec extends RFC1522Codec implements
StringEncoder, StringDecoder
* 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
+ * Thrown if the argument is not a {@code String}. Thrown if a
failure condition is encountered
* during the decode process.
*/
@Override
diff --git a/src/main/java/org/apache/commons/codec/net/QCodec.java
b/src/main/java/org/apache/commons/codec/net/QCodec.java
index 5f056df..f42ea66 100644
--- a/src/main/java/org/apache/commons/codec/net/QCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/QCodec.java
@@ -301,7 +301,7 @@ public class QCodec extends RFC1522Codec implements
StringEncoder, StringDecoder
* 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
+ * Thrown if the argument is not a {@code String}. Thrown if a
failure condition is encountered
* during the decode process.
*/
@Override
@@ -339,7 +339,7 @@ public class QCodec extends RFC1522Codec implements
StringEncoder, StringDecoder
/**
* Tests if optional transformation of SPACE characters is to be used
*
- * @return <code>true</code> if SPACE characters are to be transformed,
<code>false</code> otherwise
+ * @return {@code true} if SPACE characters are to be transformed, {@code
false} otherwise
*/
public boolean isEncodeBlanks() {
return this.encodeBlanks;
@@ -349,7 +349,7 @@ public class QCodec extends RFC1522Codec implements
StringEncoder, StringDecoder
* Defines whether optional transformation of SPACE characters is to be
used
*
* @param b
- * <code>true</code> if SPACE characters are to be transformed,
<code>false</code> otherwise
+ * {@code true} if SPACE characters are to be transformed,
{@code false} otherwise
*/
public void setEncodeBlanks(final boolean b) {
this.encodeBlanks = b;
diff --git
a/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
b/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
index aeb5aca..d3a327f 100644
--- a/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
@@ -176,7 +176,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* byte to encode
* @param buffer
* the buffer to write to
- * @return The number of bytes written to the <code>buffer</code>
+ * @return The number of bytes written to the {@code buffer}
*/
private static final int encodeQuotedPrintable(final int b, final
ByteArrayOutputStream buffer) {
buffer.write(ESCAPE_CHAR);
@@ -188,14 +188,14 @@ public class QuotedPrintableCodec implements
BinaryEncoder, BinaryDecoder, Strin
}
/**
- * Return the byte at position <code>index</code> of the byte array and
+ * Return the byte at position {@code index} of the byte array and
* make sure it is unsigned.
*
* @param index
* position in the array
* @param bytes
* the byte array
- * @return the unsigned octet at position <code>index</code> from the array
+ * @return the unsigned octet at position {@code index} from the array
*/
private static int getUnsignedOctet(final int index, final byte[] bytes) {
int b = bytes[index];
@@ -230,7 +230,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
*
* @param b
* byte to be checked
- * @return <code>true</code> if the byte is either a space or tab character
+ * @return {@code true} if the byte is either a space or tab character
*/
private static boolean isWhitespace(final int b) {
return b == SPACE || b == TAB;
@@ -519,7 +519,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* 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
+ * Thrown if the argument is not a {@code String} or {@code
byte[]}. Thrown if a failure
* condition is encountered during the decode process.
*/
@Override
diff --git a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
index 2f791ca..f1e892a 100644
--- a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
+++ b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
@@ -114,7 +114,7 @@ abstract class RFC1522Codec {
*
* @param text
* a string to decode
- * @return A new decoded String or <code>null</code> if the input is
<code>null</code>.
+ * @return A new decoded String or {@code null} if the input is {@code
null}.
* @throws DecoderException
* thrown if there is an error condition during the decoding
process.
* @throws UnsupportedEncodingException
diff --git a/src/main/java/org/apache/commons/codec/net/URLCodec.java
b/src/main/java/org/apache/commons/codec/net/URLCodec.java
index 78021ae..2d3f9f5 100644
--- a/src/main/java/org/apache/commons/codec/net/URLCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/URLCodec.java
@@ -332,7 +332,7 @@ public class URLCodec implements BinaryEncoder,
BinaryDecoder, StringEncoder, St
* 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
+ * Thrown if the argument is not a {@code String} or {@code
byte[]}. Thrown if a failure
* condition is encountered during the decode process.
*/
@Override
@@ -359,7 +359,7 @@ public class URLCodec implements BinaryEncoder,
BinaryDecoder, StringEncoder, St
}
/**
- * The <code>String</code> encoding used for decoding and encoding.
+ * The {@code String} encoding used for decoding and encoding.
*
* @return Returns the encoding.
*
diff --git a/src/main/java/org/apache/commons/codec/net/Utils.java
b/src/main/java/org/apache/commons/codec/net/Utils.java
index 872812b..256bc59 100644
--- a/src/main/java/org/apache/commons/codec/net/Utils.java
+++ b/src/main/java/org/apache/commons/codec/net/Utils.java
@@ -34,7 +34,7 @@ class Utils {
private static final int RADIX = 16;
/**
- * Returns the numeric value of the character <code>b</code> in radix 16.
+ * Returns the numeric value of the character {@code b} in radix 16.
*
* @param b
* The byte to be converted.
diff --git
a/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java
b/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java
index ac109ae..98e904e 100644
--- a/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java
+++ b/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java
@@ -28,7 +28,7 @@ import org.junit.Assert;
import org.junit.Test;
/**
- * Tests the <code>ColognePhonetic</code> class.
+ * Tests the {@code ColognePhonetic} class.
*
* <p>Keep this file in UTF-8 encoding for proper Javadoc processing.</p>
*
