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 7838f06b Javadoc
7838f06b is described below
commit 7838f06b28ea3662f10826f917cef59b4444418e
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jul 21 11:26:51 2024 -0400
Javadoc
Use HTML 'em' tag instead of 'i' tag
---
.../commons/crypto/cipher/CryptoCipherFactory.java | 2 +-
.../apache/commons/crypto/stream/CryptoInputStream.java | 4 ++--
.../apache/commons/crypto/stream/CryptoOutputStream.java | 4 ++--
.../commons/crypto/stream/CtrCryptoInputStream.java | 4 ++--
.../org/apache/commons/crypto/stream/input/Input.java | 16 ++++++++--------
.../org/apache/commons/crypto/stream/output/Output.java | 16 ++++++++--------
src/main/java/org/apache/commons/crypto/utils/Utils.java | 2 +-
7 files changed, 24 insertions(+), 24 deletions(-)
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 f2b44619..6be1c0fe 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
@@ -163,7 +163,7 @@ public class CryptoCipherFactory {
* commons.crypto.cipher.transformation
*
* @param transformation the name of the transformation, e.g.,
- * <i>AES/CBC/PKCS5Padding</i>.
+ * <em>AES/CBC/PKCS5Padding</em>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @return CryptoCipher the cipher object (defaults to OpenSslCipher if
available, else JceCipher)
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 8f1bee5b..02cdfe09 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -213,7 +213,7 @@ public class CryptoInputStream extends InputStream
implements ReadableByteChanne
* Constructs a {@link CryptoInputStream}.
*
* @param transformation the name of the transformation, e.g.,
- * <i>AES/CBC/PKCS5Padding</i>.
+ * <em>AES/CBC/PKCS5Padding</em>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @param properties The {@code Properties} class represents a set of
@@ -234,7 +234,7 @@ public class CryptoInputStream extends InputStream
implements ReadableByteChanne
* Constructs a {@link CryptoInputStream}.
*
* @param transformation the name of the transformation, e.g.,
- * <i>AES/CBC/PKCS5Padding</i>.
+ * <em>AES/CBC/PKCS5Padding</em>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @param properties The {@code Properties} class represents a set of
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 f63f7ae0..6759c42c 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
@@ -137,7 +137,7 @@ public class CryptoOutputStream extends OutputStream
implements
* Constructs a {@link CryptoOutputStream}.
*
* @param transformation the name of the transformation, e.g.,
- * <i>AES/CBC/PKCS5Padding</i>.
+ * <em>AES/CBC/PKCS5Padding</em>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @param properties The {@code Properties} class represents a set of
@@ -160,7 +160,7 @@ public class CryptoOutputStream extends OutputStream
implements
* Constructs a {@link CryptoOutputStream}.
*
* @param transformation the name of the transformation, e.g.,
- * <i>AES/CBC/PKCS5Padding</i>.
+ * <em>AES/CBC/PKCS5Padding</em>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @param properties The {@code Properties} class represents a set of
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 12da5122..ce12a2e8 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
@@ -384,8 +384,8 @@ public class CtrCryptoInputStream extends CryptoInputStream
{
/**
* Does the decryption using inBuffer as input and buf as output. Upon
* return, inBuffer is cleared; the buf's position will be equal to
- * <i>p</i> {@code +} <i>n</i> where <i>p</i> is the position
- * before decryption, <i>n</i> is the number of bytes decrypted. The buf's
+ * <em>p</em> {@code +} <em>n</em> where <em>p</em> is the
position
+ * before decryption, <em>n</em> is the number of bytes decrypted. The
buf's
* limit will not have changed.
*
* @param buf The buffer into which bytes are to be transferred.
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 2192050a..8aae90b8 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
@@ -64,19 +64,19 @@ public interface Input extends Closeable {
* Reads a sequence of bytes from input into the given buffer.
*
* <p>
- * An attempt is made to read up to <i>r</i> bytes from the input, where
- * <i>r</i> is the number of bytes remaining in the buffer, that is,
+ * An attempt is made to read up to <em>r</em> bytes from the input, where
+ * <em>r</em> is the number of bytes remaining in the buffer, that is,
* {@code dst.remaining()}, at the moment this method is invoked.
*
* <p>
- * Suppose that a byte sequence of length <i>n</i> is read, where {@code 0}
- * {@code <=} <i>n</i> {@code <=} <i>r</i>.
+ * Suppose that a byte sequence of length <em>n</em> is read, where {@code
0}
+ * {@code <=} <em>n</em> {@code <=} <em>r</em>.
* This byte sequence will be transferred into the buffer so that the first
- * byte in the sequence is at index <i>p</i> and the last byte is at index
- * <i>p</i> {@code +} <i>n</i> {@code -} {@code 1},
- * where <i>p</i> is the buffer's position at the moment this method is
+ * byte in the sequence is at index <em>p</em> and the last byte is at
index
+ * <em>p</em> {@code +} <em>n</em> {@code -} {@code 1},
+ * where <em>p</em> is the buffer's position at the moment this method is
* invoked. Upon return the buffer's position will be equal to
- * <i>p</i> {@code +} <i>n</i>; its limit will not have changed.
+ * <em>p</em> {@code +} <em>n</em>; its limit will not have
changed.
*
* @param dst The buffer into which bytes are to be transferred.
* @return the total number of bytes read into the buffer, or
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 30812ce0..80c1ba8f 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
@@ -59,19 +59,19 @@ public interface Output extends Closeable {
* Writes a sequence of bytes to this output from the given buffer.
*
* <p>
- * An attempt is made to write up to <i>r</i> bytes to the channel, where
- * <i>r</i> is the number of bytes remaining in the buffer, that is,
+ * An attempt is made to write up to <em>r</em> bytes to the channel, where
+ * <em>r</em> is the number of bytes remaining in the buffer, that is,
* {@code src.remaining()}, at the moment this method is invoked.
*
* <p>
- * Suppose that a byte sequence of length <i>n</i> is written, where
- * {@code 0} {@code <=} <i>n</i> {@code <=}
- * <i>r</i>. This byte sequence will be transferred from the buffer
- * starting at index <i>p</i>, where <i>p</i> is the buffer's position at
+ * Suppose that a byte sequence of length <em>n</em> is written, where
+ * {@code 0} {@code <=} <em>n</em> {@code <=}
+ * <em>r</em>. This byte sequence will be transferred from the buffer
+ * starting at index <em>p</em>, where <em>p</em> is the buffer's position
at
* the moment this method is invoked; the index of the last byte written
- * will be <i>p</i> {@code +} <i>n</i> {@code -}
+ * will be <em>p</em> {@code +} <em>n</em> {@code -}
* {@code 1}. Upon return the buffer's position will be equal to
- * <i>p</i> {@code +} <i>n</i>; its limit will not have changed.
+ * <em>p</em> {@code +} <em>n</em>; its limit will not have
changed.
*
* @param src The buffer from which bytes are to be retrieved.
*
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 d24836eb..69b963e0 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -159,7 +159,7 @@ public final class Utils {
* @param properties The {@link Properties} class represents a set of
* properties.
* @param transformation the name of the transformation, e.g.,
- * <i>AES/CBC/PKCS5Padding</i>.
+ * <em>AES/CBC/PKCS5Padding</em>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @return the CryptoCipher instance.
