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-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new 3b5c553 Javadoc: Replace <code></code> HTML tags with Javadoc {@code}
notation.
3b5c553 is described below
commit 3b5c553f936b2d95100c990ea7238f62ddc9e47f
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Dec 10 00:19:00 2019 -0500
Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
---
.../apache/commons/crypto/NativeCodeLoader.java | 2 +-
.../apache/commons/crypto/cipher/CryptoCipher.java | 6 +++---
.../commons/crypto/cipher/CryptoCipherFactory.java | 2 +-
.../apache/commons/crypto/cipher/JceCipher.java | 6 +++---
.../org/apache/commons/crypto/cipher/OpenSsl.java | 24 +++++++++++-----------
.../commons/crypto/cipher/OpenSslCipher.java | 4 ++--
.../commons/crypto/jna/OpenSslJnaCipher.java | 4 ++--
.../commons/crypto/jna/OpenSslJnaCryptoRandom.java | 4 ++--
.../commons/crypto/random/CryptoRandomFactory.java | 2 +-
.../commons/crypto/random/OpenSslCryptoRandom.java | 4 ++--
.../commons/crypto/stream/CryptoInputStream.java | 10 ++++-----
.../commons/crypto/stream/CryptoOutputStream.java | 4 ++--
.../crypto/stream/CtrCryptoInputStream.java | 10 ++++-----
.../crypto/stream/CtrCryptoOutputStream.java | 8 ++++----
.../crypto/stream/PositionedCryptoInputStream.java | 2 +-
.../commons/crypto/stream/input/ChannelInput.java | 16 +++++++--------
.../apache/commons/crypto/stream/input/Input.java | 24 +++++++++++-----------
.../commons/crypto/stream/input/StreamInput.java | 14 ++++++-------
.../crypto/stream/output/ChannelOutput.java | 6 +++---
.../commons/crypto/stream/output/Output.java | 8 ++++----
.../commons/crypto/stream/output/StreamOutput.java | 4 ++--
.../org/apache/commons/crypto/utils/Utils.java | 2 +-
22 files changed, 83 insertions(+), 83 deletions(-)
diff --git a/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
b/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
index ea4f35d..edb1973 100644
--- a/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
+++ b/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
@@ -255,7 +255,7 @@ final class NativeCodeLoader {
/**
* Checks whether native code is loaded for this platform.
*
- * @return <code>true</code> if native is loaded, else <code>false</code>.
+ * @return {@code true} if native is loaded, else {@code false}.
*/
static boolean isNativeCodeLoaded() {
return nativeCodeLoaded;
diff --git a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
index 722bc6c..ea1edfd 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
@@ -70,7 +70,7 @@ public interface CryptoCipher extends Closeable {
* policy files).
* @throws InvalidAlgorithmParameterException if the given algorithm
* parameters are inappropriate for this cipher, or this cipher
- * requires algorithm parameters and <code>params</code> is null,
or
+ * requires algorithm parameters and {@code params} is null, or
* the given algorithm parameters imply a cryptographic strength
* that would exceed the legal limits (as determined from the
* configured jurisdiction policy files).
@@ -84,7 +84,7 @@ public interface CryptoCipher extends Closeable {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws ShortBufferException if there is insufficient space in the
output
* buffer
*/
@@ -113,7 +113,7 @@ public interface CryptoCipher extends Closeable {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws BadPaddingException if this cipher is in decryption mode, and
* (un)padding has been requested, but the decrypted data is not
* bounded by the appropriate padding bytes
diff --git
a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
index 7de06ce..669a001 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
@@ -195,7 +195,7 @@ public class CryptoCipherFactory {
/**
* Gets the cipher class.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @return the cipher class based on the props.
*/
diff --git a/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
b/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
index 0df3f4b..c06ab49 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
@@ -90,7 +90,7 @@ class JceCipher implements CryptoCipher {
* @param params the algorithm parameters
* @throws InvalidAlgorithmParameterException if the given algorithm
* parameters are inappropriate for this cipher, or this cipher
- * requires algorithm parameters and <code>params</code> is null,
or
+ * requires algorithm parameters and {@code params} is null, or
* the given algorithm parameters imply a cryptographic strength
* that would exceed the legal limits (as determined from the
* configured jurisdiction policy files).
@@ -111,7 +111,7 @@ class JceCipher implements CryptoCipher {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws ShortBufferException if there is insufficient space in the
output
* buffer
*/
@@ -148,7 +148,7 @@ class JceCipher implements CryptoCipher {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws BadPaddingException if this cipher is in decryption mode, and
* (un)padding has been requested, but the decrypted data is not
* bounded by the appropriate padding bytes
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSsl.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSsl.java
index 12c0d9d..31e053b 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSsl.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSsl.java
@@ -130,16 +130,16 @@ final class OpenSsl {
}
/**
- * Return an <code>OpenSslCipher</code> object that implements the
specified
+ * Return an {@code OpenSslCipher} object that implements the specified
* transformation.
*
* @param transformation the name of the transformation, e.g.,
* AES/CTR/NoPadding.
- * @return OpenSslCipher an <code>OpenSslCipher</code> object
- * @throws NoSuchAlgorithmException if <code>transformation</code> is null,
+ * @return OpenSslCipher an {@code OpenSslCipher} object
+ * @throws NoSuchAlgorithmException if {@code transformation} is null,
* empty, in an invalid format, or if OpenSsl doesn't implement the
* specified algorithm.
- * @throws NoSuchPaddingException if <code>transformation</code> contains a
+ * @throws NoSuchPaddingException if {@code transformation} contains a
* padding scheme that is not available.
* @throws IllegalStateException if native code cannot be initialised
*/
@@ -227,8 +227,8 @@ final class OpenSsl {
* </p>
*
* <p>
- * All <code>input.remaining()</code> bytes starting at
- * <code>input.position()</code> are processed. The result is stored in the
+ * All {@code input.remaining()} bytes starting at
+ * {@code input.position()} are processed. The result is stored in the
* output buffer.
* </p>
*
@@ -239,12 +239,12 @@ final class OpenSsl {
* buffer's limit will not have changed.
* </p>
*
- * If <code>output.remaining()</code> bytes are insufficient to hold the
- * result, a <code>ShortBufferException</code> is thrown.
+ * If {@code output.remaining()} bytes are insufficient to hold the
+ * result, a {@code ShortBufferException} is thrown.
*
* @param input the input ByteBuffer
* @param output the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws ShortBufferException if there is insufficient space in the
output
* buffer
*/
@@ -314,8 +314,8 @@ final class OpenSsl {
* </p>
*
* <p>
- * If <code>output.remaining()</code> bytes are insufficient to hold the
- * result, a <code>ShortBufferException</code> is thrown.
+ * If {@code output.remaining()} bytes are insufficient to hold the
+ * result, a {@code ShortBufferException} is thrown.
* </p>
*
* <p>
@@ -329,7 +329,7 @@ final class OpenSsl {
*
* @param input the input ByteBuffer
* @param output the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws ShortBufferException if the given output byte array is too small
* to hold the result.
* @throws IllegalBlockSizeException if this cipher is a block cipher, no
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSslCipher.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSslCipher.java
index aa0dfd2..14dbeaa 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSslCipher.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSslCipher.java
@@ -116,7 +116,7 @@ class OpenSslCipher implements CryptoCipher {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws ShortBufferException if there is insufficient space in the
output
* buffer
*/
@@ -153,7 +153,7 @@ class OpenSslCipher implements CryptoCipher {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws BadPaddingException if this openSslEngine is in decryption
mode, and
* (un)padding has been requested, but the decrypted data is not
* bounded by the appropriate padding bytes
diff --git a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
index 01de554..3dd1f08 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
@@ -134,7 +134,7 @@ class OpenSslJnaCipher implements CryptoCipher {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws ShortBufferException if there is insufficient space in the
output
* buffer
*/
@@ -177,7 +177,7 @@ class OpenSslJnaCipher implements CryptoCipher {
*
* @param inBuffer the input ByteBuffer
* @param outBuffer the output ByteBuffer
- * @return int number of bytes stored in <code>output</code>
+ * @return int number of bytes stored in {@code output}
* @throws BadPaddingException if this cipher is in decryption mode, and
* (un)padding has been requested, but the decrypted data is not
* bounded by the appropriate padding bytes
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
index 823637d..b73e0cd 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCryptoRandom.java
@@ -132,8 +132,8 @@ class OpenSslJnaCryptoRandom extends Random implements
CryptoRandom {
* zeros).
*
* @param numBits number of random bits to be generated, where 0
- * {@literal <=} <code>numBits</code> {@literal <=} 32.
- * @return int an <code>int</code> containing the user-specified number of
+ * {@literal <=} {@code numBits} {@literal <=} 32.
+ * @return int an {@code int} containing the user-specified number of
* random bits (right justified, with leading zeros).
*/
@Override
diff --git
a/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
b/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
index 5f222fb..5e814ac 100644
--- a/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
+++ b/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
@@ -220,7 +220,7 @@ public class CryptoRandomFactory {
/**
* Gets the CryptoRandom class.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @return the CryptoRandom class based on the props.
*/
diff --git
a/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
b/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
index 8c9f48b..37cf79c 100644
--- a/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/random/OpenSslCryptoRandom.java
@@ -126,8 +126,8 @@ class OpenSslCryptoRandom extends Random implements
CryptoRandom {
* zeros).
*
* @param numBits number of random bits to be generated, where 0
- * {@literal <=} <code>numBits</code> {@literal <=} 32.
- * @return int an <code>int</code> containing the user-specified number of
+ * {@literal <=} {@code numBits} {@literal <=} 32.
+ * @return int an {@code int} containing the user-specified number of
* random bits (right justified, with leading zeros).
*/
@Override
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
index a7f7622..bb5ea9b 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -107,7 +107,7 @@ public class CryptoInputStream extends InputStream
implements
* <i>AES/CBC/PKCS5Padding</i>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param in the input stream.
* @param key crypto key for the cipher.
@@ -128,7 +128,7 @@ public class CryptoInputStream extends InputStream
implements
* <i>AES/CBC/PKCS5Padding</i>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param in the ReadableByteChannel object.
* @param key crypto key for the cipher.
@@ -210,7 +210,7 @@ public class CryptoInputStream extends InputStream
implements
* Overrides the {@link java.io.InputStream#read()}. Reads the next byte of
* data from the input stream.
*
- * @return the next byte of data, or <code>-1</code> if the end of the
+ * @return the next byte of data, or {@code -1} if the end of the
* stream is reached.
* @throws IOException if an I/O error occurs.
*/
@@ -271,7 +271,7 @@ public class CryptoInputStream extends InputStream
implements
/**
* Overrides the {@link java.io.InputStream#skip(long)}. Skips over and
- * discards <code>n</code> bytes of data from this input stream.
+ * discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
* @return the actual number of bytes skipped.
@@ -630,7 +630,7 @@ public class CryptoInputStream extends InputStream
implements
/**
* Reads crypto buffer size.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @return the buffer size.
* */
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
index b92d975..a7c7ae4 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
@@ -90,7 +90,7 @@ public class CryptoOutputStream extends OutputStream
implements
* <i>AES/CBC/PKCS5Padding</i>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param out the output stream.
* @param key crypto key for the cipher.
@@ -113,7 +113,7 @@ public class CryptoOutputStream extends OutputStream
implements
* <i>AES/CBC/PKCS5Padding</i>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param out the WritableByteChannel instance.
* @param key crypto key for the cipher.
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
index 5a4ad95..84196f3 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
@@ -83,7 +83,7 @@ public class CtrCryptoInputStream extends CryptoInputStream {
/**
* Constructs a {@link CtrCryptoInputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param in the input stream.
* @param key crypto key for the cipher.
@@ -98,7 +98,7 @@ public class CtrCryptoInputStream extends CryptoInputStream {
/**
* Constructs a {@link CtrCryptoInputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param in the ReadableByteChannel instance.
* @param key crypto key for the cipher.
@@ -158,7 +158,7 @@ public class CtrCryptoInputStream extends CryptoInputStream
{
/**
* Constructs a {@link CtrCryptoInputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param in the InputStream instance.
* @param key crypto key for the cipher.
@@ -176,7 +176,7 @@ public class CtrCryptoInputStream extends CryptoInputStream
{
/**
* Constructs a {@link CtrCryptoInputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param in the ReadableByteChannel instance.
* @param key crypto key for the cipher.
@@ -253,7 +253,7 @@ public class CtrCryptoInputStream extends CryptoInputStream
{
/**
* Overrides the {@link CryptoInputStream#skip(long)}. Skips over and
- * discards <code>n</code> bytes of data from this input stream.
+ * discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
* @return the actual number of bytes skipped.
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
index 958d1a5..ff5089d 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
@@ -87,7 +87,7 @@ public class CtrCryptoOutputStream extends CryptoOutputStream
{
/**
* Constructs a {@link CtrCryptoOutputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param out the output stream.
* @param key crypto key for the cipher.
@@ -102,7 +102,7 @@ public class CtrCryptoOutputStream extends
CryptoOutputStream {
/**
* Constructs a {@link CtrCryptoOutputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param out the WritableByteChannel instance.
* @param key crypto key for the cipher.
@@ -163,7 +163,7 @@ public class CtrCryptoOutputStream extends
CryptoOutputStream {
/**
* Constructs a {@link CtrCryptoOutputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param out the output stream.
* @param key crypto key for the cipher.
@@ -181,7 +181,7 @@ public class CtrCryptoOutputStream extends
CryptoOutputStream {
/**
* Constructs a {@link CtrCryptoOutputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param out the WritableByteChannel instance.
* @param key crypto key for the cipher.
diff --git
a/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
index 150824b..172db49 100644
---
a/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
+++
b/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
@@ -62,7 +62,7 @@ public class PositionedCryptoInputStream extends
CtrCryptoInputStream {
/**
* Constructs a {@link PositionedCryptoInputStream}.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param in the input data.
* @param key crypto key for the cipher.
diff --git
a/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
b/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
index d85dba1..ce4c9da 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
@@ -22,9 +22,9 @@ import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel;
/**
- * The ChannelInput class takes a <code>ReadableByteChannel</code> object and
- * wraps it as <code>Input</code> object acceptable by
- * <code>CryptoInputStream</code>.
+ * The ChannelInput class takes a {@code ReadableByteChannel} object and
+ * wraps it as {@code Input} object acceptable by
+ * {@code CryptoInputStream}.
*/
public class ChannelInput implements Input {
private static final int SKIP_BUFFER_SIZE = 2048;
@@ -49,7 +49,7 @@ public class ChannelInput implements Input {
*
* @param dst The buffer into which bytes are to be transferred.
* @return the total number of bytes read into the buffer, or
- * <code>-1</code> if there is no more data because the end of the
+ * {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
*/
@@ -61,7 +61,7 @@ public class ChannelInput implements Input {
/**
* Overrides the
* {@link org.apache.commons.crypto.stream.input.Input#skip(long)}. Skips
- * over and discards <code>n</code> bytes of data from this input stream.
+ * over and discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
* @return the actual number of bytes skipped.
@@ -112,8 +112,8 @@ public class ChannelInput implements Input {
/**
* Overrides the
* {@link org.apache.commons.crypto.stream.input.Input#read(long, byte[],
int, int)}
- * . Reads up to <code>len</code> bytes of data from the input stream into
- * an array of bytes. An attempt is made to read as many as
<code>len</code>
+ * . Reads up to {@code len} bytes of data from the input stream into
+ * an array of bytes. An attempt is made to read as many as {@code len}
* bytes, but a smaller number may be read. The number of bytes actually
* read is returned as an integer.
*
@@ -122,7 +122,7 @@ public class ChannelInput implements Input {
* @param offset the start offset in array buffer.
* @param length the maximum number of bytes to read.
* @return the total number of bytes read into the buffer, or
- * <code>-1</code> if there is no more data because the end of the
+ * {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
*/
diff --git a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
index fff7e1d..54c17ae 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
@@ -22,10 +22,10 @@ import java.nio.ByteBuffer;
/**
* The Input interface abstract the input source of
- * <code>CryptoInputStream</code> so that different implementation of input can
+ * {@code CryptoInputStream} so that different implementation of input can
* be used. The implementation Input interface will usually wraps an input
- * mechanism such as <code>InputStream</code> or
- * <code>ReadableByteChannel</code>.
+ * mechanism such as {@code InputStream} or
+ * {@code ReadableByteChannel}.
*/
public interface Input {
/**
@@ -48,24 +48,24 @@ public interface Input {
*
* @param dst The buffer into which bytes are to be transferred.
* @return the total number of bytes read into the buffer, or
- * <code>-1</code> if there is no more data because the end of the
+ * {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException If some other I/O error occurs.
*/
int read(ByteBuffer dst) throws IOException;
/**
- * Skips over and discards <code>n</code> bytes of data from this input The
- * <code>skip</code> method may, for a variety of reasons, end up skipping
- * over some smaller number of bytes, possibly <code>0</code>. This may
+ * Skips over and discards {@code n} bytes of data from this input The
+ * {@code skip} method may, for a variety of reasons, end up skipping
+ * over some smaller number of bytes, possibly {@code 0}. This may
* result from any of a number of conditions; reaching end of file before
- * <code>n</code> bytes have been skipped is only one possibility. The
- * actual number of bytes skipped is returned. If <code>n</code> is
+ * {@code n} bytes have been skipped is only one possibility. The
+ * actual number of bytes skipped is returned. If {@code n} is
* negative, no bytes are skipped.
*
* <p>
- * The <code>skip</code> method of this class creates a byte array and then
- * repeatedly reads into it until <code>n</code> bytes have been read or
the
+ * The {@code skip} method of this class creates a byte array and then
+ * repeatedly reads into it until {@code n} bytes have been read or the
* end of the stream has been reached. Subclasses are encouraged to provide
* a more efficient implementation of this method. For instance, the
* implementation may depend on the ability to seek.
@@ -108,7 +108,7 @@ public interface Input {
* @param offset the start offset in array buffer.
* @param length the maximum number of bytes to read.
* @return the total number of bytes read into the buffer, or
- * <code>-1</code> if there is no more data because the end of the
+ * {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
*/
diff --git
a/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
b/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
index cbbcb9a..f9f6610 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
@@ -22,8 +22,8 @@ import java.io.InputStream;
import java.nio.ByteBuffer;
/**
- * The StreamInput class takes a <code>InputStream</code> object and wraps it
as
- * <code>Input</code> object acceptable by <code>CryptoInputStream</code>.
+ * The StreamInput class takes a {@code InputStream} object and wraps it as
+ * {@code Input} object acceptable by {@code CryptoInputStream}.
*/
public class StreamInput implements Input {
private final byte[] buf;
@@ -50,7 +50,7 @@ public class StreamInput implements Input {
* @param dst The buffer into which bytes are to be transferred.
*
* @return the total number of bytes read into the buffer, or
- * <code>-1</code> if there is no more data because the end of the
+ * {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
*/
@@ -77,7 +77,7 @@ public class StreamInput implements Input {
/**
* Overrides the
* {@link org.apache.commons.crypto.stream.input.Input#skip(long)}. Skips
- * over and discards <code>n</code> bytes of data from this input stream.
+ * over and discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
* @return the actual number of bytes skipped.
@@ -109,8 +109,8 @@ public class StreamInput implements Input {
/**
* Overrides the
* {@link org.apache.commons.crypto.stream.input.Input#read(long, byte[],
int, int)}
- * . Reads up to <code>len</code> bytes of data from the input stream into
- * an array of bytes. An attempt is made to read as many as
<code>len</code>
+ * . Reads up to {@code len} bytes of data from the input stream into
+ * an array of bytes. An attempt is made to read as many as {@code len}
* bytes, but a smaller number may be read. The number of bytes actually
* read is returned as an integer.
*
@@ -119,7 +119,7 @@ public class StreamInput implements Input {
* @param offset the start offset in array buffer.
* @param length the maximum number of bytes to read.
* @return the total number of bytes read into the buffer, or
- * <code>-1</code> if there is no more data because the end of the
+ * {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
*/
diff --git
a/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
b/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
index d8a5373..41abc77 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
@@ -22,9 +22,9 @@ import java.nio.ByteBuffer;
import java.nio.channels.WritableByteChannel;
/**
- * The ChannelOutput class takes a <code>WritableByteChannel</code> object and
- * wraps it as <code>Output</code> object acceptable by
- * <code>CryptoOutputStream</code> as the output target.
+ * The ChannelOutput class takes a {@code WritableByteChannel} object and
+ * wraps it as {@code Output} object acceptable by
+ * {@code CryptoOutputStream} as the output target.
*/
public class ChannelOutput implements Output {
diff --git a/src/main/java/org/apache/commons/crypto/stream/output/Output.java
b/src/main/java/org/apache/commons/crypto/stream/output/Output.java
index 5dbb835..be086f3 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/Output.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/Output.java
@@ -22,10 +22,10 @@ import java.nio.ByteBuffer;
/**
* The Output interface abstract the output target of
- * <code>CryptoOutputStream</code> so that different implementation of output
+ * {@code CryptoOutputStream} so that different implementation of output
* can be used. The implementation Output interface will usually wraps an
output
- * mechanism such as <code>OutputStream</code> or
- * <code>WritableByteChannel</code>.
+ * mechanism such as {@code OutputStream} or
+ * {@code WritableByteChannel}.
*/
public interface Output {
@@ -58,7 +58,7 @@ public interface Output {
/**
* Flushes this output and forces any buffered output bytes to be written
* out if the under layer output method support. The general contract of
- * <code>flush</code> is that calling it is an indication that, if any
bytes
+ * {@code flush} is that calling it is an indication that, if any bytes
* previously written have been buffered by the implementation of the
output
* stream, such bytes should immediately be written to their intended
* destination.
diff --git
a/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
b/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
index e76c11c..616f06e 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
@@ -22,8 +22,8 @@ import java.io.OutputStream;
import java.nio.ByteBuffer;
/**
- * The StreamOutput class takes a <code>OutputStream</code> object and wraps it
- * as <code>Output</code> object acceptable by <code>CryptoOutputStream</code>
+ * The StreamOutput class takes a {@code OutputStream} object and wraps it
+ * as {@code Output} object acceptable by {@code CryptoOutputStream}
* as the output target.
*/
public class StreamOutput implements Output {
diff --git a/src/main/java/org/apache/commons/crypto/utils/Utils.java
b/src/main/java/org/apache/commons/crypto/utils/Utils.java
index 66c17c3..ae6324a 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -112,7 +112,7 @@ public final class Utils {
* Helper method to create a CryptoCipher instance and throws only
* IOException.
*
- * @param props The <code>Properties</code> class represents a set of
+ * @param props The {@code Properties} class represents a set of
* properties.
* @param transformation the name of the transformation, e.g.,
* <i>AES/CBC/PKCS5Padding</i>.
