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
The following commit(s) were added to refs/heads/master by this push: new 87da2aad Javadoc 87da2aad is described below commit 87da2aad791c595843d26fe81e8fd1a760906ad1 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Fri Jun 2 14:47:53 2023 -0400 Javadoc --- src/test/java/org/apache/commons/io/ByteOrderParserTest.java | 3 +++ src/test/java/org/apache/commons/io/CopyUtilsTest.java | 2 +- src/test/java/org/apache/commons/io/DemuxInputStreamTest.java | 2 +- src/test/java/org/apache/commons/io/DirectoryWalkerTest.java | 4 +--- src/test/java/org/apache/commons/io/EndianUtilsTest.java | 1 + src/test/java/org/apache/commons/io/FileCleanerTest.java | 4 +--- src/test/java/org/apache/commons/io/FileCleaningTrackerTest.java | 4 +--- src/test/java/org/apache/commons/io/FileDeleteStrategyTest.java | 4 +--- src/test/java/org/apache/commons/io/FileSystemUtilsTest.java | 2 +- src/test/java/org/apache/commons/io/FileUtilsCopyToFileTest.java | 2 +- .../java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java | 3 +++ src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java | 2 +- src/test/java/org/apache/commons/io/FileUtilsListFilesTest.java | 2 +- src/test/java/org/apache/commons/io/FileUtilsTest.java | 4 +--- src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java | 2 +- src/test/java/org/apache/commons/io/FilenameUtilsTest.java | 4 +--- src/test/java/org/apache/commons/io/FilenameUtilsWildcardTest.java | 3 +++ src/test/java/org/apache/commons/io/HexDumpTest.java | 2 +- src/test/java/org/apache/commons/io/IOExceptionWithCauseTest.java | 2 +- src/test/java/org/apache/commons/io/IOIndexedExceptionTest.java | 2 -- src/test/java/org/apache/commons/io/IOUtilsCopyTest.java | 2 +- src/test/java/org/apache/commons/io/TaggedIOExceptionTest.java | 2 +- src/test/java/org/apache/commons/io/UncheckedIOExceptionsTest.java | 3 +-- 23 files changed, 28 insertions(+), 33 deletions(-) diff --git a/src/test/java/org/apache/commons/io/ByteOrderParserTest.java b/src/test/java/org/apache/commons/io/ByteOrderParserTest.java index 268c9c33..80ab365f 100644 --- a/src/test/java/org/apache/commons/io/ByteOrderParserTest.java +++ b/src/test/java/org/apache/commons/io/ByteOrderParserTest.java @@ -23,6 +23,9 @@ import java.nio.ByteOrder; import org.junit.jupiter.api.Test; +/** + * Test for {@link ByteOrderParser}. + */ public class ByteOrderParserTest { private ByteOrder parseByteOrder(final String value) { diff --git a/src/test/java/org/apache/commons/io/CopyUtilsTest.java b/src/test/java/org/apache/commons/io/CopyUtilsTest.java index 51d96b90..e0bab26a 100644 --- a/src/test/java/org/apache/commons/io/CopyUtilsTest.java +++ b/src/test/java/org/apache/commons/io/CopyUtilsTest.java @@ -37,7 +37,7 @@ import org.junit.jupiter.api.Test; @SuppressWarnings("deprecation") // these are test cases for the deprecated CopyUtils /** - * JUnit tests for CopyUtils. + * Test for {@link CopyUtils}. * * @see CopyUtils */ diff --git a/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java b/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java index dd71814b..6872bc54 100644 --- a/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java +++ b/src/test/java/org/apache/commons/io/DemuxInputStreamTest.java @@ -33,7 +33,7 @@ import org.apache.commons.io.test.TestUtils; import org.junit.jupiter.api.Test; /** - * Basic unit tests for the multiplexing streams. + * Tests {@link DemuxInputStream}. */ public class DemuxInputStreamTest { diff --git a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java index b9ca1d23..b90a7ed2 100644 --- a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java +++ b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java @@ -35,9 +35,7 @@ import org.apache.commons.io.filefilter.NameFileFilter; import org.junit.jupiter.api.Test; /** - * This is used to test DirectoryWalker for correctness. - * - * @see DirectoryWalker + * Tests {@link DirectoryWalker}. */ public class DirectoryWalkerTest { diff --git a/src/test/java/org/apache/commons/io/EndianUtilsTest.java b/src/test/java/org/apache/commons/io/EndianUtilsTest.java index 52fbaedb..79df0c66 100644 --- a/src/test/java/org/apache/commons/io/EndianUtilsTest.java +++ b/src/test/java/org/apache/commons/io/EndianUtilsTest.java @@ -27,6 +27,7 @@ import java.io.IOException; import org.junit.jupiter.api.Test; /** + * Tests {@link EndianUtils}. */ public class EndianUtilsTest { diff --git a/src/test/java/org/apache/commons/io/FileCleanerTest.java b/src/test/java/org/apache/commons/io/FileCleanerTest.java index e807b32c..b23c79d9 100644 --- a/src/test/java/org/apache/commons/io/FileCleanerTest.java +++ b/src/test/java/org/apache/commons/io/FileCleanerTest.java @@ -17,9 +17,7 @@ package org.apache.commons.io; /** - * This is used to test {@link FileCleaner} for correctness. - * - * @see FileCleaner + * Tests {@link FileCleaner}. */ @SuppressWarnings("deprecation") // testing deprecated class public class FileCleanerTest extends FileCleaningTrackerTest { diff --git a/src/test/java/org/apache/commons/io/FileCleaningTrackerTest.java b/src/test/java/org/apache/commons/io/FileCleaningTrackerTest.java index a1fb92ff..bb47ae23 100644 --- a/src/test/java/org/apache/commons/io/FileCleaningTrackerTest.java +++ b/src/test/java/org/apache/commons/io/FileCleaningTrackerTest.java @@ -39,9 +39,7 @@ import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; /** - * This is used to test {@link FileCleaningTracker} for correctness. - * - * @see FileCleaningTracker + * Tests {@link FileCleaningTracker}. */ public class FileCleaningTrackerTest extends AbstractTempDirTest { diff --git a/src/test/java/org/apache/commons/io/FileDeleteStrategyTest.java b/src/test/java/org/apache/commons/io/FileDeleteStrategyTest.java index 4a78c169..cf3af63d 100644 --- a/src/test/java/org/apache/commons/io/FileDeleteStrategyTest.java +++ b/src/test/java/org/apache/commons/io/FileDeleteStrategyTest.java @@ -30,9 +30,7 @@ import org.apache.commons.io.test.TestUtils; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; /** - * Test for FileDeleteStrategy. - * - * @see FileDeleteStrategy + * Tests {@link FileDeleteStrategy}. */ public class FileDeleteStrategyTest { diff --git a/src/test/java/org/apache/commons/io/FileSystemUtilsTest.java b/src/test/java/org/apache/commons/io/FileSystemUtilsTest.java index f0b19b3c..617f03c0 100644 --- a/src/test/java/org/apache/commons/io/FileSystemUtilsTest.java +++ b/src/test/java/org/apache/commons/io/FileSystemUtilsTest.java @@ -33,7 +33,7 @@ import java.util.Locale; import org.junit.jupiter.api.Test; /** - * This is used to test FileSystemUtils. + * Tests {@link FileSystemUtils}. */ @SuppressWarnings("deprecation") // testing deprecated class public class FileSystemUtilsTest { diff --git a/src/test/java/org/apache/commons/io/FileUtilsCopyToFileTest.java b/src/test/java/org/apache/commons/io/FileUtilsCopyToFileTest.java index bf0a0e3e..9994ef09 100644 --- a/src/test/java/org/apache/commons/io/FileUtilsCopyToFileTest.java +++ b/src/test/java/org/apache/commons/io/FileUtilsCopyToFileTest.java @@ -27,7 +27,7 @@ import org.junit.jupiter.api.io.TempDir; /** - * This is used to test FileUtils for correctness. + * Tests {@link FileUtils}. */ public class FileUtilsCopyToFileTest { diff --git a/src/test/java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java b/src/test/java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java index d078f152..c4e5ccbc 100644 --- a/src/test/java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java +++ b/src/test/java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java @@ -31,6 +31,9 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.condition.DisabledOnOs; import org.junit.jupiter.api.condition.OS; +/** + * Tests {@link FileUtils}. + */ @DisabledOnOs({OS.WINDOWS, OS.MAC}) public class FileUtilsDeleteDirectoryLinuxTest extends FileUtilsDeleteDirectoryBaseTest { diff --git a/src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java b/src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java index 51eef36d..933e9bec 100644 --- a/src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java +++ b/src/test/java/org/apache/commons/io/FileUtilsFileNewerTest.java @@ -33,7 +33,7 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; /** - * This is used to test FileUtils for correctness. + * Tests {@link FileUtils}. */ public class FileUtilsFileNewerTest { diff --git a/src/test/java/org/apache/commons/io/FileUtilsListFilesTest.java b/src/test/java/org/apache/commons/io/FileUtilsListFilesTest.java index 9603d73e..27a81c98 100644 --- a/src/test/java/org/apache/commons/io/FileUtilsListFilesTest.java +++ b/src/test/java/org/apache/commons/io/FileUtilsListFilesTest.java @@ -34,7 +34,7 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; /** - * Test cases for FileUtils.listFiles() methods. + * Tests FileUtils.listFiles() methods. */ public class FileUtilsListFilesTest { diff --git a/src/test/java/org/apache/commons/io/FileUtilsTest.java b/src/test/java/org/apache/commons/io/FileUtilsTest.java index b0e870b4..4f2bfebc 100644 --- a/src/test/java/org/apache/commons/io/FileUtilsTest.java +++ b/src/test/java/org/apache/commons/io/FileUtilsTest.java @@ -90,9 +90,7 @@ import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; /** - * This is used to test FileUtils for correctness. - * - * @see FileUtils + * Tests {@link FileUtils}. */ @SuppressWarnings({"deprecation", "ResultOfMethodCallIgnored"}) // unit tests include tests of many deprecated methods public class FileUtilsTest extends AbstractTempDirTest { diff --git a/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java b/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java index 6dc52d5c..a601b273 100644 --- a/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java +++ b/src/test/java/org/apache/commons/io/FileUtilsWaitForTest.java @@ -24,7 +24,7 @@ import java.util.concurrent.atomic.AtomicBoolean; import org.junit.jupiter.api.Test; /** - * This is used to test FileUtils.waitFor() method for correctness. + * Tests FileUtils.waitFor(). * <p> * This class has been broken out from FileUtilsTestCase to solve issues as per BZ 38927 * </p> diff --git a/src/test/java/org/apache/commons/io/FilenameUtilsTest.java b/src/test/java/org/apache/commons/io/FilenameUtilsTest.java index 68620673..5055eaf4 100644 --- a/src/test/java/org/apache/commons/io/FilenameUtilsTest.java +++ b/src/test/java/org/apache/commons/io/FilenameUtilsTest.java @@ -38,9 +38,7 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; /** - * This is used to test FilenameUtils for correctness. - * - * @see FilenameUtils + * Tests {@link FilenameUtils}. */ public class FilenameUtilsTest { diff --git a/src/test/java/org/apache/commons/io/FilenameUtilsWildcardTest.java b/src/test/java/org/apache/commons/io/FilenameUtilsWildcardTest.java index 439562ad..14dba6d1 100644 --- a/src/test/java/org/apache/commons/io/FilenameUtilsWildcardTest.java +++ b/src/test/java/org/apache/commons/io/FilenameUtilsWildcardTest.java @@ -26,6 +26,9 @@ import java.util.Locale; import org.junit.jupiter.api.Test; +/** + * Tests {@link FilenameUtils} {@code wildcardMatch()} methods. + */ public class FilenameUtilsWildcardTest { private static final boolean WINDOWS = File.separatorChar == '\\'; diff --git a/src/test/java/org/apache/commons/io/HexDumpTest.java b/src/test/java/org/apache/commons/io/HexDumpTest.java index df26a550..06c6e7ca 100644 --- a/src/test/java/org/apache/commons/io/HexDumpTest.java +++ b/src/test/java/org/apache/commons/io/HexDumpTest.java @@ -25,8 +25,8 @@ import org.apache.commons.io.output.ByteArrayOutputStream; import org.apache.commons.io.test.ThrowOnCloseOutputStream; import org.junit.jupiter.api.Test; - /** + * Tests {@link HexDump}. */ public class HexDumpTest { diff --git a/src/test/java/org/apache/commons/io/IOExceptionWithCauseTest.java b/src/test/java/org/apache/commons/io/IOExceptionWithCauseTest.java index 5f3e261d..6f5d7bdb 100644 --- a/src/test/java/org/apache/commons/io/IOExceptionWithCauseTest.java +++ b/src/test/java/org/apache/commons/io/IOExceptionWithCauseTest.java @@ -25,7 +25,7 @@ import java.io.IOException; import org.junit.jupiter.api.Test; /** - * Tests IOExceptionWithCause + * Tests {@link IOExceptionWithCause}. */ public class IOExceptionWithCauseTest { diff --git a/src/test/java/org/apache/commons/io/IOIndexedExceptionTest.java b/src/test/java/org/apache/commons/io/IOIndexedExceptionTest.java index 906f93c5..e390620c 100644 --- a/src/test/java/org/apache/commons/io/IOIndexedExceptionTest.java +++ b/src/test/java/org/apache/commons/io/IOIndexedExceptionTest.java @@ -27,8 +27,6 @@ import org.junit.jupiter.api.Test; /** * Tests {@link IOIndexedException}. - * - * @since 2.7 */ public class IOIndexedExceptionTest { diff --git a/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java b/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java index 75e00bd2..344f34b6 100644 --- a/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java +++ b/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java @@ -45,7 +45,7 @@ import org.apache.commons.io.test.ThrowOnFlushAndCloseOutputStream; import org.junit.jupiter.api.Test; /** - * Test {@link IOUtils} copy methods. + * Tests {@link IOUtils} copy methods. */ public class IOUtilsCopyTest { diff --git a/src/test/java/org/apache/commons/io/TaggedIOExceptionTest.java b/src/test/java/org/apache/commons/io/TaggedIOExceptionTest.java index a009d431..09b2443c 100644 --- a/src/test/java/org/apache/commons/io/TaggedIOExceptionTest.java +++ b/src/test/java/org/apache/commons/io/TaggedIOExceptionTest.java @@ -27,7 +27,7 @@ import java.util.UUID; import org.junit.jupiter.api.Test; /** - * JUnit Test Case for {@link TaggedIOException}. + * Tests {@link TaggedIOException}. */ public class TaggedIOExceptionTest { diff --git a/src/test/java/org/apache/commons/io/UncheckedIOExceptionsTest.java b/src/test/java/org/apache/commons/io/UncheckedIOExceptionsTest.java index 7eaf23f5..c1e4ba1b 100644 --- a/src/test/java/org/apache/commons/io/UncheckedIOExceptionsTest.java +++ b/src/test/java/org/apache/commons/io/UncheckedIOExceptionsTest.java @@ -22,11 +22,10 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import java.io.IOException; import java.io.UncheckedIOException; -import org.apache.commons.io.function.Uncheck; import org.junit.jupiter.api.Test; /** - * Tests {@link Uncheck}. + * Tests {@link UncheckedIOExceptions}. */ public class UncheckedIOExceptionsTest {