This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 f34bbf08 Javadoc
f34bbf08 is described below
commit f34bbf08752ac3ab3c9edf4300e09dbb04a0b9fc
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:25 2026 -0400
Javadoc
---
.../apache/commons/crypto/jna/LibreSsl20XNativeJna.java | 14 +++++++-------
.../org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java | 14 +++++++-------
.../org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java | 14 +++++++-------
.../apache/commons/crypto/stream/CryptoInputStream.java | 2 +-
.../apache/commons/crypto/stream/input/ChannelInput.java | 2 +-
.../java/org/apache/commons/crypto/stream/input/Input.java | 2 +-
.../apache/commons/crypto/stream/input/StreamInput.java | 2 +-
src/main/java/org/apache/commons/crypto/utils/AES.java | 2 +-
src/main/java/org/apache/commons/crypto/utils/Padding.java | 2 +-
.../org/apache/commons/crypto/utils/ReflectionUtils.java | 2 +-
src/main/java/org/apache/commons/crypto/utils/Utils.java | 4 ++--
11 files changed, 30 insertions(+), 30 deletions(-)
diff --git
a/src/main/java/org/apache/commons/crypto/jna/LibreSsl20XNativeJna.java
b/src/main/java/org/apache/commons/crypto/jna/LibreSsl20XNativeJna.java
index 585b3a2e..9d30b2dd 100644
--- a/src/main/java/org/apache/commons/crypto/jna/LibreSsl20XNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/LibreSsl20XNativeJna.java
@@ -130,32 +130,32 @@ final class LibreSsl20XNativeJna implements
OpenSslInterfaceNativeJna {
public static native NativeLong ERR_peek_error();
/**
- * @return an OpenSSL AES EVP cipher instance with a 128-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 128-bit key CBC mode
*/
public static native PointerByReference EVP_aes_128_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 128-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 128-bit key CTR mode
*/
public static native PointerByReference EVP_aes_128_ctr();
/**
- * @return an OpenSSL AES EVP cipher instance with a 192-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 192-bit key CBC mode
*/
public static native PointerByReference EVP_aes_192_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 192-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 192-bit key CTR mode
*/
public static native PointerByReference EVP_aes_192_ctr();
/**
- * @return an OpenSSL AES EVP cipher instance with a 256-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 256-bit key CBC mode
*/
public static native PointerByReference EVP_aes_256_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 256-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 256-bit key CTR mode
*/
public static native PointerByReference EVP_aes_256_ctr();
@@ -189,7 +189,7 @@ final class LibreSsl20XNativeJna implements
OpenSslInterfaceNativeJna {
/**
* Creates a cipher context.
*
- * @return a pointer to a newly created EVP_CIPHER_CTX for success and
NULL for failure.
+ * @return A pointer to a newly created EVP_CIPHER_CTX for success and
NULL for failure.
*/
public static native PointerByReference EVP_CIPHER_CTX_new();
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
index 3c72c7f0..3c45190c 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
@@ -116,32 +116,32 @@ final class OpenSsl11XNativeJna implements
OpenSslInterfaceNativeJna {
public static native NativeLong ERR_peek_error();
/**
- * @return an OpenSSL AES EVP cipher instance with a 128-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 128-bit key CBC mode
*/
public static native PointerByReference EVP_aes_128_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 128-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 128-bit key CTR mode
*/
public static native PointerByReference EVP_aes_128_ctr();
/**
- * @return an OpenSSL AES EVP cipher instance with a 192-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 192-bit key CBC mode
*/
public static native PointerByReference EVP_aes_192_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 192-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 192-bit key CTR mode
*/
public static native PointerByReference EVP_aes_192_ctr();
/**
- * @return an OpenSSL AES EVP cipher instance with a 256-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 256-bit key CBC mode
*/
public static native PointerByReference EVP_aes_256_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 256-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 256-bit key CTR mode
*/
public static native PointerByReference EVP_aes_256_ctr();
@@ -157,7 +157,7 @@ final class OpenSsl11XNativeJna implements
OpenSslInterfaceNativeJna {
/**
* Creates a cipher context.
*
- * @return a pointer to a newly created EVP_CIPHER_CTX for success and
NULL for failure.
+ * @return A pointer to a newly created EVP_CIPHER_CTX for success and
NULL for failure.
*/
public static native PointerByReference EVP_CIPHER_CTX_new();
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java
index 4cb28534..d36d4082 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java
@@ -118,32 +118,32 @@ final class OpenSsl30XNativeJna implements
OpenSslInterfaceNativeJna {
public static native NativeLong ERR_peek_error();
/**
- * @return an OpenSSL AES EVP cipher instance with a 128-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 128-bit key CBC mode
*/
public static native PointerByReference EVP_aes_128_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 128-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 128-bit key CTR mode
*/
public static native PointerByReference EVP_aes_128_ctr();
/**
- * @return an OpenSSL AES EVP cipher instance with a 192-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 192-bit key CBC mode
*/
public static native PointerByReference EVP_aes_192_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 192-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 192-bit key CTR mode
*/
public static native PointerByReference EVP_aes_192_ctr();
/**
- * @return an OpenSSL AES EVP cipher instance with a 256-bit key CBC mode
+ * @return An OpenSSL AES EVP cipher instance with a 256-bit key CBC mode
*/
public static native PointerByReference EVP_aes_256_cbc();
/**
- * @return an OpenSSL AES EVP cipher instance with a 256-bit key CTR mode
+ * @return An OpenSSL AES EVP cipher instance with a 256-bit key CTR mode
*/
public static native PointerByReference EVP_aes_256_ctr();
@@ -159,7 +159,7 @@ final class OpenSsl30XNativeJna implements
OpenSslInterfaceNativeJna {
/**
* Creates a cipher context.
*
- * @return a pointer to a newly created EVP_CIPHER_CTX for success and
NULL for failure.
+ * @return A pointer to a newly created EVP_CIPHER_CTX for success and
NULL for failure.
*/
public static native PointerByReference EVP_CIPHER_CTX_new();
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 1d87b8ca..b08a6a46 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -257,7 +257,7 @@ public CryptoInputStream(final String transformation,
* without blocking by the next invocation of a method for this input
* stream.
*
- * @return an estimate of the number of bytes that can be read (or skipped
+ * @return An estimate of the number of bytes that can be read (or skipped
* over) from this input stream without blocking or {@code 0} when
* it reaches the end of the input stream.
* @throws IOException if an I/O error occurs.
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 3c4a10ee..8d114ea2 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
@@ -54,7 +54,7 @@ public ChannelInput(final ReadableByteChannel channel) {
* single read or skip of this many bytes will not block, but may read or
* skip fewer bytes.
*
- * @return an estimate of the number of bytes that can be read (or skipped
+ * @return An estimate of the number of bytes that can be read (or skipped
* over) from this input stream without blocking or {@code 0} when
* it reaches the end of the input stream.
* @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 f81338aa..9dd1fec9 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
@@ -45,7 +45,7 @@ public interface Input extends Closeable {
* It is never correct to use the return value of this method to allocate a
* buffer intended to hold all data in this stream.
*
- * @return an estimate of the number of bytes that can be read (or skipped
+ * @return An estimate of the number of bytes that can be read (or skipped
* over) from this input stream without blocking or {@code 0} when
* it reaches the end of the input stream.
* @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 09ad3c6d..0cd7f6d7 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
@@ -57,7 +57,7 @@ public StreamInput(final InputStream inputStream, final int
bufferSize) {
* single read or skip of this many bytes will not block, but may read or
* skip fewer bytes.
*
- * @return an estimate of the number of bytes that can be read (or skipped
+ * @return An estimate of the number of bytes that can be read (or skipped
* over) from this input stream without blocking or {@code 0} when
* it reaches the end of the input stream.
* @throws IOException if an I/O error occurs.
diff --git a/src/main/java/org/apache/commons/crypto/utils/AES.java
b/src/main/java/org/apache/commons/crypto/utils/AES.java
index 18a9f1aa..959148ea 100644
--- a/src/main/java/org/apache/commons/crypto/utils/AES.java
+++ b/src/main/java/org/apache/commons/crypto/utils/AES.java
@@ -53,7 +53,7 @@ public class AES {
* Creates a new SecretKeySpec for the given key and {@link #ALGORITHM}.
*
* @param key a key.
- * @return a new SecretKeySpec.
+ * @return A new SecretKeySpec.
*/
public static SecretKeySpec newSecretKeySpec(final byte[] key) {
return new SecretKeySpec(key, ALGORITHM);
diff --git a/src/main/java/org/apache/commons/crypto/utils/Padding.java
b/src/main/java/org/apache/commons/crypto/utils/Padding.java
index 539e6cc3..be2a92d5 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Padding.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Padding.java
@@ -35,7 +35,7 @@ public enum Padding {
* Gets a Padding.
*
* @param padding the padding name.
- * @return a Padding instance.
+ * @return A Padding instance.
* @throws NoSuchPaddingException if the algorithm is not supported.
*/
public static Padding get(final String padding) throws
NoSuchPaddingException {
diff --git a/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
b/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
index 3d5f1d27..abf7221b 100644
--- a/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
@@ -134,7 +134,7 @@ private static Class<?> getClassByNameOrNull(final String
name) {
* @param klass the Class object.
* @param args array of objects to be passed as arguments to the
constructor
* call.
- * @return a new object created by calling the constructor this object
+ * @return A new object created by calling the constructor this object
* represents.
*/
public static <T> T newInstance(final Class<T> klass, final Object...
args) {
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 8458734a..6f9bc709 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -178,7 +178,7 @@ public static CryptoCipher getCipherInstance(final String
transformation, final
* plus any other properties found in the file
* {@link #SYSTEM_PROPERTIES_FILE}
*
- * @return a Properties instance with defaults
+ * @return A Properties instance with defaults
*/
public static Properties getDefaultProperties() {
return new Properties(DefaultPropertiesHolder.DEFAULT_PROPERTIES);
@@ -232,7 +232,7 @@ static String libraryPath(final String name) {
* @param classNames a string consist of a list of the entries joined by a
* delimiter, may be {@code null} or empty in which case an empty
list is returned.
* @param separator a delimiter for the input string.
- * @return a list of class entries.
+ * @return A list of class entries.
*/
public static List<String> splitClassNames(final String classNames, final
String separator) {
final List<String> res = new ArrayList<>();
