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 169e57ba Javadoc
169e57ba is described below
commit 169e57bae3c9aac61194c1bb222f59cffbd2bb95
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Dec 14 13:49:39 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/crypto/utils/Utils.java | 4 ++--
.../java/org/apache/commons/crypto/cipher/AbstractCipherTest.java | 8 ++++----
.../commons/crypto/stream/PositionedCryptoInputStreamTest.java | 8 ++++----
3 files changed, 10 insertions(+), 10 deletions(-)
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 57bfc3da..baa4bd83 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -37,10 +37,10 @@ import org.apache.commons.crypto.cipher.CryptoCipherFactory;
*/
public final class Utils {
- /** mask to keep a byte from a longer number */
+ /** Mask to keep a byte from a longer number */
public static final int BYTE_MASK = 0xFF;
- /** maximum number of OpenSslVersion entries to retrieve */
+ /** Maximum number of OpenSslVersion entries to retrieve */
public static final int OPENSSL_VERSION_MAX_INDEX = 20; // max seen so far
is 9, but leave some spare
private static final class DefaultPropertiesHolder {
diff --git
a/src/test/java/org/apache/commons/crypto/cipher/AbstractCipherTest.java
b/src/test/java/org/apache/commons/crypto/cipher/AbstractCipherTest.java
index 2bca20ef..7b945f3f 100644
--- a/src/test/java/org/apache/commons/crypto/cipher/AbstractCipherTest.java
+++ b/src/test/java/org/apache/commons/crypto/cipher/AbstractCipherTest.java
@@ -67,7 +67,7 @@ public abstract class AbstractCipherTest {
private CryptoCipher enc, dec;
- /** test byte array whose data is randomly generated */
+ /** Test byte array whose data is randomly generated */
private void byteArrayTest(final String transformation, final byte[]
key, final byte[] iv) throws Exception {
final int blockSize = enc.getBlockSize();
@@ -116,7 +116,7 @@ public abstract class AbstractCipherTest {
}
}
- /** test byte array whose data is planned in {@link TestData} */
+ /** Test byte array whose data is planned in {@link TestData} */
private void byteArrayTest(final String transformation, final byte[]
key, final byte[] iv, final byte[] input,
final byte[] output) throws Exception {
resetCipher(transformation, key, iv);
@@ -237,7 +237,7 @@ public abstract class AbstractCipherTest {
@Test
public void testCryptoTest() throws Exception {
for (final String tran : transformations) {
- /** uses the small data set in {@link TestData} */
+ /** Uses the small data set in {@link TestData} */
cipherTests = TestData.getTestData(tran);
assertNotNull(cipherTests, "TestData cannot supply data
for: " + tran);
for (int i = 0; i != cipherTests.length; i += 5) {
@@ -258,7 +258,7 @@ public abstract class AbstractCipherTest {
byteArrayTest(tran, key, iv, inputBytes,
outputBytes);
}
- /** uses randomly generated big data set */
+ /** Uses randomly generated big data set */
byteArrayTest(tran, KEY, IV);
}
}
diff --git
a/src/test/java/org/apache/commons/crypto/stream/PositionedCryptoInputStreamTest.java
b/src/test/java/org/apache/commons/crypto/stream/PositionedCryptoInputStreamTest.java
index d661f29f..637d1d3c 100644
---
a/src/test/java/org/apache/commons/crypto/stream/PositionedCryptoInputStreamTest.java
+++
b/src/test/java/org/apache/commons/crypto/stream/PositionedCryptoInputStreamTest.java
@@ -157,7 +157,7 @@ public class PositionedCryptoInputStreamTest {
prepareData();
}
- /** compare the data from pos with length and data2 from 0 with length. */
+ /** Compares the data from pos with length and data2 from 0 with length. */
private void compareByteArray(final byte[] data1, final int pos, final
byte[] data2,
final int length) {
final byte[] expectedData = new byte[length];
@@ -353,7 +353,7 @@ public class PositionedCryptoInputStreamTest {
}
}
- /** test for the out of index position, eg, -1. */
+ /** Tests for the out of index position, eg, -1. */
private void testPositionedReadNone(final String cipherClass, final int
position,
final int length, final int bufferSize) throws Exception {
try (CryptoCipher cipher = getCipher(cipherClass);
@@ -364,7 +364,7 @@ public class PositionedCryptoInputStreamTest {
}
}
- /** test for the End of file reached before reading fully. */
+ /** Tests for the End of file reached before reading fully. */
private void testReadFullyFailed(final String cipherClass, final int
position,
final int length, final int bufferSize) throws Exception {
try (CryptoCipher cipher = getCipher(cipherClass);
@@ -392,7 +392,7 @@ public class PositionedCryptoInputStreamTest {
}
}
- /** test for the out of index position, eg, -1. */
+ /** Tests for the out of index position, eg, -1. */
private void testSeekFailed(final String cipherClass, final int position,
final int bufferSize)
throws Exception {
try (CryptoCipher cipher = getCipher(cipherClass);
