[commons-crypto] 17/18: Javadoc

[gg...@apache.org]

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

commit b55aacd760c48182988261aab9ea51257aeccb22
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Oct 22 08:46:48 2023 -0400

    Javadoc
---
 .../crypto/stream/PositionedCryptoInputStreamTest.java     | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

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 dae90ca..8d5d83d 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
+    /** compare 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];
@@ -176,8 +176,10 @@ public class PositionedCryptoInputStreamTest {
         }
     }
 
-    // when there are multiple positioned read actions and one read action,
-    // they will not interfere each other.
+    /**
+     *  when there are multiple positioned read actions and one read action,
+     *  they will not interfere each other.
+     */
     private void doMultipleReadTest(final String cipherClass) throws Exception {
         try (CryptoCipher cipher = getCipher(cipherClass);
                 PositionedCryptoInputStream in = getCryptoInputStream(cipher, bufferSize)) {
@@ -356,7 +358,7 @@ public class PositionedCryptoInputStreamTest {
         }
     }
 
-    // test for the out of index position, eg, -1.
+    /** test 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);
@@ -367,7 +369,7 @@ public class PositionedCryptoInputStreamTest {
         }
     }
 
-    // test for the End of file reached before reading fully
+    /** test 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);
@@ -395,7 +397,7 @@ public class PositionedCryptoInputStreamTest {
         }
     }
 
-    // test for the out of index position, eg, -1.
+    /** test 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);