You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/06/02 20:47:16 UTC
[commons-io] branch master updated (8b9e574b -> 5c87fbc9)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
from 8b9e574b Javadoc
new d20d8681 Javadoc
new 5ab69e76 Javadoc
new ce3d52e1 Javadoc
new 5c87fbc9 Javadoc
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../java/org/apache/commons/io/input/AutoCloseInputStreamTest.java | 2 +-
.../java/org/apache/commons/io/input/BrokenInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/BrokenReaderTest.java | 2 +-
.../org/apache/commons/io/input/CloseShieldInputStreamTest.java | 2 +-
.../java/org/apache/commons/io/input/CloseShieldReaderTest.java | 2 +-
.../java/org/apache/commons/io/input/ClosedInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/ClosedReaderTest.java | 2 +-
src/test/java/org/apache/commons/io/input/NullInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/NullReaderTest.java | 2 +-
.../java/org/apache/commons/io/input/TaggedInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/TaggedReaderTest.java | 2 +-
src/test/java/org/apache/commons/io/input/TeeInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/TeeReaderTest.java | 2 +-
.../org/apache/commons/io/output/AppendableOutputStreamTest.java | 2 +-
.../java/org/apache/commons/io/output/AppendableWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/BrokenOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/BrokenWriterTest.java | 2 +-
.../org/apache/commons/io/output/ByteArrayOutputStreamTest.java | 2 +-
.../java/org/apache/commons/io/output/ChunkedOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java | 3 +++
.../org/apache/commons/io/output/CloseShieldOutputStreamTest.java | 2 +-
.../java/org/apache/commons/io/output/CloseShieldWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/ClosedOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/ClosedWriterTest.java | 2 +-
.../org/apache/commons/io/output/CountingOutputStreamTest.java | 1 +
.../org/apache/commons/io/output/FileWriterWithEncodingTest.java | 2 +-
src/test/java/org/apache/commons/io/output/NullAppendableTest.java | 2 +-
.../java/org/apache/commons/io/output/NullOutputStreamTest.java | 4 +---
.../java/org/apache/commons/io/output/NullPrintStreamTest.java | 4 +---
.../org/apache/commons/io/output/ProxyCollectionWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/ProxyOutputStreamTest.java | 2 +-
.../java/org/apache/commons/io/output/TaggedOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/TaggedWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/TeeOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/TeeWriterTest.java | 2 +-
.../org/apache/commons/io/output/ThresholdingOutputStreamTest.java | 3 +++
.../java/org/apache/commons/io/output/UncheckedAppendableTest.java | 2 +-
.../apache/commons/io/output/UncheckedFilterOutputStreamTest.java | 2 +-
.../org/apache/commons/io/output/UncheckedFilterWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/WriterOutputStreamTest.java | 4 ++++
.../apache/commons/io/serialization/FullClassNameMatcherTest.java | 3 +++
.../org/apache/commons/io/serialization/MoreComplexObjectTest.java | 7 ++++---
.../commons/io/serialization/RegexpClassNameMatcherTest.java | 3 +++
.../commons/io/serialization/ValidatingObjectInputStreamTest.java | 3 +++
.../commons/io/serialization/WildcardClassNameMatcherTest.java | 3 +++
45 files changed, 63 insertions(+), 43 deletions(-)
[commons-io] 04/04: Javadoc
Posted by 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-io.git
commit 5c87fbc9b9d3e956739e2acb601df8e1db26ca35
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Jun 2 15:10:00 2023 -0400
Javadoc
---
.../java/org/apache/commons/io/serialization/MoreComplexObjectTest.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/test/java/org/apache/commons/io/serialization/MoreComplexObjectTest.java b/src/test/java/org/apache/commons/io/serialization/MoreComplexObjectTest.java
index bf07e4a6..82729508 100644
--- a/src/test/java/org/apache/commons/io/serialization/MoreComplexObjectTest.java
+++ b/src/test/java/org/apache/commons/io/serialization/MoreComplexObjectTest.java
@@ -32,7 +32,7 @@ import java.util.Random;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
-/**
+/**
* This is more an example than a test - deserialize our {@link MoreComplexObject}
* to verify which settings it requires, as the object uses a number of primitive
* and java.* member objects.
[commons-io] 01/04: Javadoc
Posted by 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-io.git
commit d20d8681437c5b3cdad739e254823bafe427230d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Jun 2 15:04:05 2023 -0400
Javadoc
---
.../apache/commons/io/serialization/FullClassNameMatcherTest.java | 3 +++
.../org/apache/commons/io/serialization/MoreComplexObjectTest.java | 7 ++++---
.../commons/io/serialization/RegexpClassNameMatcherTest.java | 3 +++
.../commons/io/serialization/ValidatingObjectInputStreamTest.java | 3 +++
.../commons/io/serialization/WildcardClassNameMatcherTest.java | 3 +++
5 files changed, 16 insertions(+), 3 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/serialization/FullClassNameMatcherTest.java b/src/test/java/org/apache/commons/io/serialization/FullClassNameMatcherTest.java
index fce1be13..f92d6052 100644
--- a/src/test/java/org/apache/commons/io/serialization/FullClassNameMatcherTest.java
+++ b/src/test/java/org/apache/commons/io/serialization/FullClassNameMatcherTest.java
@@ -23,6 +23,9 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link FullClassNameMatcher}.
+ */
public class FullClassNameMatcherTest {
private static final String [] NAMES_ARRAY = { Integer.class.getName(), Long.class.getName() };
diff --git a/src/test/java/org/apache/commons/io/serialization/MoreComplexObjectTest.java b/src/test/java/org/apache/commons/io/serialization/MoreComplexObjectTest.java
index a57a4656..bf07e4a6 100644
--- a/src/test/java/org/apache/commons/io/serialization/MoreComplexObjectTest.java
+++ b/src/test/java/org/apache/commons/io/serialization/MoreComplexObjectTest.java
@@ -32,9 +32,10 @@ import java.util.Random;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
-/** This is more an example than a test - deserialize our {@link MoreComplexObject}
- * to verify which settings it requires, as the object uses a number of primitive
- * and java.* member objects.
+/**
+ * This is more an example than a test - deserialize our {@link MoreComplexObject}
+ * to verify which settings it requires, as the object uses a number of primitive
+ * and java.* member objects.
*/
public class MoreComplexObjectTest extends AbstractCloseableListTest {
diff --git a/src/test/java/org/apache/commons/io/serialization/RegexpClassNameMatcherTest.java b/src/test/java/org/apache/commons/io/serialization/RegexpClassNameMatcherTest.java
index c90c92db..5f0243d5 100644
--- a/src/test/java/org/apache/commons/io/serialization/RegexpClassNameMatcherTest.java
+++ b/src/test/java/org/apache/commons/io/serialization/RegexpClassNameMatcherTest.java
@@ -26,6 +26,9 @@ import java.util.regex.Pattern;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link RegexpClassNameMatcher}.
+ */
public class RegexpClassNameMatcherTest {
@Test
diff --git a/src/test/java/org/apache/commons/io/serialization/ValidatingObjectInputStreamTest.java b/src/test/java/org/apache/commons/io/serialization/ValidatingObjectInputStreamTest.java
index fa58f679..ad33d846 100644
--- a/src/test/java/org/apache/commons/io/serialization/ValidatingObjectInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/serialization/ValidatingObjectInputStreamTest.java
@@ -36,6 +36,9 @@ import java.util.regex.Pattern;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link ValidatingObjectInputStream}.
+ */
public class ValidatingObjectInputStreamTest extends AbstractCloseableListTest {
private static final ClassNameMatcher ALWAYS_TRUE = className -> true;
private MockSerializedClass testObject;
diff --git a/src/test/java/org/apache/commons/io/serialization/WildcardClassNameMatcherTest.java b/src/test/java/org/apache/commons/io/serialization/WildcardClassNameMatcherTest.java
index e76424a8..6da59cce 100644
--- a/src/test/java/org/apache/commons/io/serialization/WildcardClassNameMatcherTest.java
+++ b/src/test/java/org/apache/commons/io/serialization/WildcardClassNameMatcherTest.java
@@ -23,6 +23,9 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link WildcardClassNameMatcher}.
+ */
public class WildcardClassNameMatcherTest {
@Test
[commons-io] 03/04: Javadoc
Posted by 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-io.git
commit ce3d52e1303b8d04e10dca7b8cd76c5a8c336548
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Jun 2 15:09:55 2023 -0400
Javadoc
---
.../java/org/apache/commons/io/output/AppendableOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/AppendableWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/BrokenOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/BrokenWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java | 2 +-
.../java/org/apache/commons/io/output/ChunkedOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java | 3 +++
.../org/apache/commons/io/output/CloseShieldOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/CloseShieldWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/ClosedOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/ClosedWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/CountingOutputStreamTest.java | 1 +
.../java/org/apache/commons/io/output/FileWriterWithEncodingTest.java | 2 +-
src/test/java/org/apache/commons/io/output/NullAppendableTest.java | 2 +-
src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java | 4 +---
src/test/java/org/apache/commons/io/output/NullPrintStreamTest.java | 4 +---
.../java/org/apache/commons/io/output/ProxyCollectionWriterTest.java | 2 +-
src/test/java/org/apache/commons/io/output/ProxyOutputStreamTest.java | 2 +-
.../java/org/apache/commons/io/output/TaggedOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/TaggedWriterTest.java | 2 +-
src/test/java/org/apache/commons/io/output/TeeOutputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/output/TeeWriterTest.java | 2 +-
.../org/apache/commons/io/output/ThresholdingOutputStreamTest.java | 3 +++
.../java/org/apache/commons/io/output/UncheckedAppendableTest.java | 2 +-
.../org/apache/commons/io/output/UncheckedFilterOutputStreamTest.java | 2 +-
.../java/org/apache/commons/io/output/UncheckedFilterWriterTest.java | 2 +-
.../java/org/apache/commons/io/output/WriterOutputStreamTest.java | 4 ++++
27 files changed, 34 insertions(+), 27 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/output/AppendableOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/AppendableOutputStreamTest.java
index a95f90bd..7fcd28b8 100644
--- a/src/test/java/org/apache/commons/io/output/AppendableOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/AppendableOutputStreamTest.java
@@ -22,7 +22,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * Unit tests for {@link AppendableOutputStream}.
+ * Tests {@link AppendableOutputStream}.
*/
public class AppendableOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/AppendableWriterTest.java b/src/test/java/org/apache/commons/io/output/AppendableWriterTest.java
index c5a796f4..acf51a80 100644
--- a/src/test/java/org/apache/commons/io/output/AppendableWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/AppendableWriterTest.java
@@ -22,7 +22,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * Unit tests for {@link AppendableWriter}.
+ * Tests {@link AppendableWriter}.
*/
public class AppendableWriterTest {
diff --git a/src/test/java/org/apache/commons/io/output/BrokenOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/BrokenOutputStreamTest.java
index 1f56c271..c392514f 100644
--- a/src/test/java/org/apache/commons/io/output/BrokenOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/BrokenOutputStreamTest.java
@@ -26,7 +26,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link BrokenOutputStream}.
+ * Tests {@link BrokenOutputStream}.
*/
public class BrokenOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/BrokenWriterTest.java b/src/test/java/org/apache/commons/io/output/BrokenWriterTest.java
index f508b246..af2c4212 100644
--- a/src/test/java/org/apache/commons/io/output/BrokenWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/BrokenWriterTest.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link BrokenWriter}.
+ * Tests {@link BrokenWriter}.
*/
public class BrokenWriterTest {
diff --git a/src/test/java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java
index 4217e020..7cfcadb6 100644
--- a/src/test/java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/ByteArrayOutputStreamTest.java
@@ -36,7 +36,7 @@ import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
/**
- * Basic unit tests for the alternative ByteArrayOutputStream implementations.
+ * Tests the alternative ByteArrayOutputStream implementations.
*/
public class ByteArrayOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/ChunkedOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/ChunkedOutputStreamTest.java
index b7460a4d..ff503754 100644
--- a/src/test/java/org/apache/commons/io/output/ChunkedOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/ChunkedOutputStreamTest.java
@@ -26,7 +26,7 @@ import org.apache.commons.io.IOUtils;
import org.junit.jupiter.api.Test;
/**
- * Test the chunked output stream
+ * Tests {@link ChunkedOutputStream}.
*/
public class ChunkedOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java b/src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java
index 5be01e1c..534030d6 100644
--- a/src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java
@@ -26,6 +26,9 @@ import java.util.concurrent.atomic.AtomicInteger;
import org.apache.commons.io.IOUtils;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link ChunkedWriter}.
+ */
public class ChunkedWriterTest {
@SuppressWarnings("resource") // closed by caller.
diff --git a/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java
index bd9d45fb..3abad888 100644
--- a/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link CloseShieldOutputStream}.
+ * Tests {@link CloseShieldOutputStream}.
*/
public class CloseShieldOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/CloseShieldWriterTest.java b/src/test/java/org/apache/commons/io/output/CloseShieldWriterTest.java
index b1069ef5..a7c3ca47 100644
--- a/src/test/java/org/apache/commons/io/output/CloseShieldWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/CloseShieldWriterTest.java
@@ -29,7 +29,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link CloseShieldWriter}.
+ * Tests {@link CloseShieldWriter}.
*/
public class CloseShieldWriterTest {
diff --git a/src/test/java/org/apache/commons/io/output/ClosedOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/ClosedOutputStreamTest.java
index 3195db49..b1968e89 100644
--- a/src/test/java/org/apache/commons/io/output/ClosedOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/ClosedOutputStreamTest.java
@@ -23,7 +23,7 @@ import java.io.IOException;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link ClosedOutputStream}.
+ * Tests {@link ClosedOutputStream}.
*/
public class ClosedOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/ClosedWriterTest.java b/src/test/java/org/apache/commons/io/output/ClosedWriterTest.java
index 555f2f6a..968702d6 100644
--- a/src/test/java/org/apache/commons/io/output/ClosedWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/ClosedWriterTest.java
@@ -23,7 +23,7 @@ import java.io.IOException;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link ClosedWriter}.
+ * Tests {@link ClosedWriter}.
*/
public class ClosedWriterTest {
diff --git a/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
index 593a762b..97758449 100644
--- a/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
@@ -27,6 +27,7 @@ import org.apache.commons.io.input.NullInputStream;
import org.junit.jupiter.api.Test;
/**
+ * Tests {@link CountingOutputStream}.
*/
public class CountingOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/FileWriterWithEncodingTest.java b/src/test/java/org/apache/commons/io/output/FileWriterWithEncodingTest.java
index f06b0a95..b6a009fb 100644
--- a/src/test/java/org/apache/commons/io/output/FileWriterWithEncodingTest.java
+++ b/src/test/java/org/apache/commons/io/output/FileWriterWithEncodingTest.java
@@ -38,7 +38,7 @@ import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
/**
- * Tests that the encoding is actually set and used.
+ * Tests {@link FileWriterWithEncoding}.
*/
public class FileWriterWithEncodingTest {
diff --git a/src/test/java/org/apache/commons/io/output/NullAppendableTest.java b/src/test/java/org/apache/commons/io/output/NullAppendableTest.java
index d7760649..6f1560f0 100644
--- a/src/test/java/org/apache/commons/io/output/NullAppendableTest.java
+++ b/src/test/java/org/apache/commons/io/output/NullAppendableTest.java
@@ -21,7 +21,7 @@ import java.io.IOException;
import org.junit.jupiter.api.Test;
/**
- * Really not a lot to do here, but checking that no Exceptions are thrown.
+ * Tests {@link NullAppendable}.
*/
public class NullAppendableTest {
diff --git a/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java
index 0991da0e..1bfd35bb 100644
--- a/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/NullOutputStreamTest.java
@@ -16,14 +16,12 @@
*/
package org.apache.commons.io.output;
-
import java.io.IOException;
import org.junit.jupiter.api.Test;
-
/**
- * Really not a lot to do here, but checking that no Exceptions are thrown.
+ * Tests {@link NullOutputStream}.
*/
public class NullOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/NullPrintStreamTest.java b/src/test/java/org/apache/commons/io/output/NullPrintStreamTest.java
index 80513feb..40abc865 100644
--- a/src/test/java/org/apache/commons/io/output/NullPrintStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/NullPrintStreamTest.java
@@ -16,14 +16,12 @@
*/
package org.apache.commons.io.output;
-
import java.io.IOException;
import org.junit.jupiter.api.Test;
-
/**
- * Really not a lot to do here, but checking that no Exceptions are thrown.
+ * Tests {@link NullPrintStream}.
*/
public class NullPrintStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/ProxyCollectionWriterTest.java b/src/test/java/org/apache/commons/io/output/ProxyCollectionWriterTest.java
index 02e01b9e..4402496c 100644
--- a/src/test/java/org/apache/commons/io/output/ProxyCollectionWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/ProxyCollectionWriterTest.java
@@ -33,7 +33,7 @@ import org.apache.commons.io.IOIndexedException;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link ProxyCollectionWriter}.
+ * Tests {@link ProxyCollectionWriter}.
*/
public class ProxyCollectionWriterTest {
diff --git a/src/test/java/org/apache/commons/io/output/ProxyOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/ProxyOutputStreamTest.java
index c49d38ba..8c3a2ec5 100644
--- a/src/test/java/org/apache/commons/io/output/ProxyOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/ProxyOutputStreamTest.java
@@ -25,7 +25,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link CloseShieldOutputStream}.
+ * Tests {@link CloseShieldOutputStream}.
*/
public class ProxyOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/TaggedOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/TaggedOutputStreamTest.java
index e9a56903..9987161e 100644
--- a/src/test/java/org/apache/commons/io/output/TaggedOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/TaggedOutputStreamTest.java
@@ -29,7 +29,7 @@ import org.apache.commons.io.TaggedIOException;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link TaggedOutputStream}.
+ * Tests {@link TaggedOutputStream}.
*/
public class TaggedOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/TaggedWriterTest.java b/src/test/java/org/apache/commons/io/output/TaggedWriterTest.java
index 7423c953..fa64fe89 100644
--- a/src/test/java/org/apache/commons/io/output/TaggedWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/TaggedWriterTest.java
@@ -29,7 +29,7 @@ import org.apache.commons.io.TaggedIOException;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link TaggedWriter}.
+ * Tests {@link TaggedWriter}.
*/
public class TaggedWriterTest {
diff --git a/src/test/java/org/apache/commons/io/output/TeeOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/TeeOutputStreamTest.java
index a417a00f..1cfa7b12 100644
--- a/src/test/java/org/apache/commons/io/output/TeeOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/TeeOutputStreamTest.java
@@ -29,7 +29,7 @@ import org.apache.commons.io.test.ThrowOnCloseOutputStream;
import org.junit.jupiter.api.Test;
/**On
- * JUnit Test Case for {@link TeeOutputStream}.
+ * Tests {@link TeeOutputStream}.
*/
public class TeeOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/TeeWriterTest.java b/src/test/java/org/apache/commons/io/output/TeeWriterTest.java
index c3e3a800..0b5af708 100644
--- a/src/test/java/org/apache/commons/io/output/TeeWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/TeeWriterTest.java
@@ -33,7 +33,7 @@ import org.apache.commons.io.IOIndexedException;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link TeeWriter}.
+ * Tests {@link TeeWriter}.
*/
@SuppressWarnings("resource") // not necessary to close these resources
public class TeeWriterTest {
diff --git a/src/test/java/org/apache/commons/io/output/ThresholdingOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/ThresholdingOutputStreamTest.java
index 8d278df4..b342d28c 100644
--- a/src/test/java/org/apache/commons/io/output/ThresholdingOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/ThresholdingOutputStreamTest.java
@@ -27,6 +27,9 @@ import java.util.concurrent.atomic.AtomicBoolean;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link ThresholdingOutputStream}.
+ */
public class ThresholdingOutputStreamTest {
@Test
diff --git a/src/test/java/org/apache/commons/io/output/UncheckedAppendableTest.java b/src/test/java/org/apache/commons/io/output/UncheckedAppendableTest.java
index fb3a7131..75a64373 100644
--- a/src/test/java/org/apache/commons/io/output/UncheckedAppendableTest.java
+++ b/src/test/java/org/apache/commons/io/output/UncheckedAppendableTest.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link UncheckedAppendable}.
+ * Tests {@link UncheckedAppendable}.
*/
public class UncheckedAppendableTest {
diff --git a/src/test/java/org/apache/commons/io/output/UncheckedFilterOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/UncheckedFilterOutputStreamTest.java
index abde30c2..65f2a526 100644
--- a/src/test/java/org/apache/commons/io/output/UncheckedFilterOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/UncheckedFilterOutputStreamTest.java
@@ -29,7 +29,7 @@ import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link BrokenWriter}.
+ * Tests {@link BrokenWriter}.
*/
public class UncheckedFilterOutputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/output/UncheckedFilterWriterTest.java b/src/test/java/org/apache/commons/io/output/UncheckedFilterWriterTest.java
index d9c1e323..4dddd993 100644
--- a/src/test/java/org/apache/commons/io/output/UncheckedFilterWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/UncheckedFilterWriterTest.java
@@ -28,7 +28,7 @@ import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link BrokenWriter}.
+ * Tests {@link BrokenWriter}.
*/
public class UncheckedFilterWriterTest {
diff --git a/src/test/java/org/apache/commons/io/output/WriterOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/WriterOutputStreamTest.java
index 10aad5f0..61355907 100644
--- a/src/test/java/org/apache/commons/io/output/WriterOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/WriterOutputStreamTest.java
@@ -31,7 +31,11 @@ import org.apache.commons.io.Charsets;
import org.apache.commons.io.charset.CharsetDecoders;
import org.junit.jupiter.api.Test;
+/**
+ * Tests {@link WriterOutputStream}.
+ */
public class WriterOutputStreamTest {
+
private static final String UTF_16LE = StandardCharsets.UTF_16LE.name();
private static final String UTF_16BE = StandardCharsets.UTF_16BE.name();
private static final String UTF_16 = StandardCharsets.UTF_16.name();
[commons-io] 02/04: Javadoc
Posted by 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-io.git
commit 5ab69e7627a5f1b41c95b8e5e4b07b5f939d2988
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Jun 2 15:09:49 2023 -0400
Javadoc
---
src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/BrokenInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/BrokenReaderTest.java | 2 +-
.../java/org/apache/commons/io/input/CloseShieldInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/CloseShieldReaderTest.java | 2 +-
src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/ClosedReaderTest.java | 2 +-
src/test/java/org/apache/commons/io/input/NullInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/NullReaderTest.java | 2 +-
src/test/java/org/apache/commons/io/input/TaggedInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/TaggedReaderTest.java | 2 +-
src/test/java/org/apache/commons/io/input/TeeInputStreamTest.java | 2 +-
src/test/java/org/apache/commons/io/input/TeeReaderTest.java | 2 +-
13 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java b/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java
index 34b98bfe..1e615843 100644
--- a/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link AutoCloseInputStream}.
+ * Tests {@link AutoCloseInputStream}.
*/
public class AutoCloseInputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/input/BrokenInputStreamTest.java b/src/test/java/org/apache/commons/io/input/BrokenInputStreamTest.java
index 82ad3f54..97447dcf 100644
--- a/src/test/java/org/apache/commons/io/input/BrokenInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/BrokenInputStreamTest.java
@@ -26,7 +26,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link BrokenInputStream}.
+ * Tests {@link BrokenInputStream}.
*/
public class BrokenInputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/input/BrokenReaderTest.java b/src/test/java/org/apache/commons/io/input/BrokenReaderTest.java
index 0bd9751a..dec1efc9 100644
--- a/src/test/java/org/apache/commons/io/input/BrokenReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/BrokenReaderTest.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link BrokenReader}.
+ * Tests {@link BrokenReader}.
*/
public class BrokenReaderTest {
diff --git a/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java b/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java
index 4a093108..a839242c 100644
--- a/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link CloseShieldInputStream}.
+ * Tests {@link CloseShieldInputStream}.
*/
public class CloseShieldInputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/input/CloseShieldReaderTest.java b/src/test/java/org/apache/commons/io/input/CloseShieldReaderTest.java
index 59a9959b..cf6e675f 100644
--- a/src/test/java/org/apache/commons/io/input/CloseShieldReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/CloseShieldReaderTest.java
@@ -28,7 +28,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link CloseShieldReader}.
+ * Tests {@link CloseShieldReader}.
*/
public class CloseShieldReaderTest {
diff --git a/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java b/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java
index 6a4d685e..a8ff62aa 100644
--- a/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java
@@ -21,7 +21,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link ClosedInputStream}.
+ * Tests {@link ClosedInputStream}.
*/
public class ClosedInputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/input/ClosedReaderTest.java b/src/test/java/org/apache/commons/io/input/ClosedReaderTest.java
index 2c9debc3..9fd5dccf 100644
--- a/src/test/java/org/apache/commons/io/input/ClosedReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/ClosedReaderTest.java
@@ -21,7 +21,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link ClosedReader}.
+ * Tests {@link ClosedReader}.
*/
public class ClosedReaderTest {
diff --git a/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java b/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java
index d4a511de..77f3c074 100644
--- a/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java
@@ -29,7 +29,7 @@ import java.io.InputStream;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link NullInputStream}.
+ * Tests {@link NullInputStream}.
*/
public class NullInputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/input/NullReaderTest.java b/src/test/java/org/apache/commons/io/input/NullReaderTest.java
index 77d3988f..d2d055fb 100644
--- a/src/test/java/org/apache/commons/io/input/NullReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/NullReaderTest.java
@@ -29,7 +29,7 @@ import java.io.Reader;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link NullReader}.
+ * Tests {@link NullReader}.
*/
public class NullReaderTest {
diff --git a/src/test/java/org/apache/commons/io/input/TaggedInputStreamTest.java b/src/test/java/org/apache/commons/io/input/TaggedInputStreamTest.java
index ffa2ff45..01fbbb94 100644
--- a/src/test/java/org/apache/commons/io/input/TaggedInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/TaggedInputStreamTest.java
@@ -30,7 +30,7 @@ import org.apache.commons.io.TaggedIOException;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link TaggedInputStream}.
+ * Tests {@link TaggedInputStream}.
*/
public class TaggedInputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/input/TaggedReaderTest.java b/src/test/java/org/apache/commons/io/input/TaggedReaderTest.java
index 9360cf25..63d23bf8 100644
--- a/src/test/java/org/apache/commons/io/input/TaggedReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/TaggedReaderTest.java
@@ -30,7 +30,7 @@ import org.apache.commons.io.TaggedIOException;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link TaggedReader}.
+ * Tests {@link TaggedReader}.
*/
public class TaggedReaderTest {
diff --git a/src/test/java/org/apache/commons/io/input/TeeInputStreamTest.java b/src/test/java/org/apache/commons/io/input/TeeInputStreamTest.java
index 7c095a36..4fdf9824 100644
--- a/src/test/java/org/apache/commons/io/input/TeeInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/TeeInputStreamTest.java
@@ -35,7 +35,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link TeeInputStream}.
+ * Tests {@link TeeInputStream}.
*/
public class TeeInputStreamTest {
diff --git a/src/test/java/org/apache/commons/io/input/TeeReaderTest.java b/src/test/java/org/apache/commons/io/input/TeeReaderTest.java
index b697ca2b..4b694fcd 100644
--- a/src/test/java/org/apache/commons/io/input/TeeReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/TeeReaderTest.java
@@ -37,7 +37,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * JUnit Test Case for {@link TeeReader}.
+ * Tests {@link TeeReader}.
*/
public class TeeReaderTest {