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 2025/12/13 13:03:23 UTC
(commons-io) branch master updated (5e08e76bf -> 56f1f77c2)
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 5e08e76bf Bump actions/cache from 4.3.0 to 5.0.1
new 11c0562b0 Javadoc
new b953e1961 Javadoc: Add missing </li> tags
new 56f1f77c2 Fix malformed Javadoc comments
The 3 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:
src/changes/changes.xml | 1 +
.../org/apache/commons/io/DirectoryWalker.java | 2 +-
src/main/java/org/apache/commons/io/FileUtils.java | 20 ++++----
src/main/java/org/apache/commons/io/IOUtils.java | 56 +++++++++++-----------
.../java/org/apache/commons/io/file/PathUtils.java | 6 +--
.../apache/commons/io/input/ProxyInputStream.java | 4 +-
6 files changed, 45 insertions(+), 44 deletions(-)
(commons-io) 03/03: Fix malformed Javadoc comments
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 56f1f77c20f696058bb265a4a43ebbef0fc8d27a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Dec 13 08:03:17 2025 -0500
Fix malformed Javadoc comments
---
src/changes/changes.xml | 1 +
.../java/org/apache/commons/io/DirectoryWalker.java | 2 +-
src/main/java/org/apache/commons/io/FileUtils.java | 20 ++++++++++----------
src/main/java/org/apache/commons/io/IOUtils.java | 10 +++++-----
.../apache/commons/io/input/ProxyInputStream.java | 4 ++--
5 files changed, 19 insertions(+), 18 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 204076824..12cf90185 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -49,6 +49,7 @@ The <action> type attribute can be add,update,fix,remove.
<!-- FIX -->
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix Apache RAT plugin console warnings.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory, Piotr P. Karwasz">ByteArraySeekableByteChannel.position|truncate(long) shouldn't throw an IllegalArgumentException for a new positive position that's too large #817.</action>
+ <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix malformed Javadoc comments.</action>
<!-- ADD -->
<action type="add" dev="ggregory" due-to="Gary Gregory">Add and use IOUtils.closeQuietly(Closeable, Throwable) #818.</action>
<!-- UPDATE -->
diff --git a/src/main/java/org/apache/commons/io/DirectoryWalker.java b/src/main/java/org/apache/commons/io/DirectoryWalker.java
index ac3d8bd5f..23f5f14f2 100644
--- a/src/main/java/org/apache/commons/io/DirectoryWalker.java
+++ b/src/main/java/org/apache/commons/io/DirectoryWalker.java
@@ -167,7 +167,7 @@
* <ul>
* <li>The decision logic on whether to cancel processing or not.</li>
* <li>Constructing and throwing a {@link CancelException}.</li>
- * <li>Custom cancel processing in the {@code handleCancelled()} method.
+ * <li>Custom cancel processing in the {@code handleCancelled()} method.</li>
* </ul>
* <p>
* Two possible scenarios are envisaged for cancellation:
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java
index a24ab813a..b86f55048 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -93,16 +93,16 @@
* Facilities are provided in the following areas:
* </p>
* <ul>
- * <li>writing to a file
- * <li>reading from a file
- * <li>make a directory including parent directories
- * <li>copying files and directories
- * <li>deleting files and directories
- * <li>converting to and from a URL
- * <li>listing files and directories by filter and extension
- * <li>comparing file content
- * <li>file last changed date
- * <li>calculating a checksum
+ * <li>writing to a file</li>
+ * <li>reading from a file</li>
+ * <li>make a directory including parent directories</li>
+ * <li>copying files and directories</li>
+ * <li>deleting files and directories</li>
+ * <li>converting to and from a URL</li>
+ * <li>listing files and directories by filter and extension</li>
+ * <li>comparing file content</li>
+ * <li>file last changed date</li>
+ * <li>calculating a checksum</li>
* </ul>
* <p>
* Note that a specific charset should be specified whenever possible. Relying on the platform default means that the
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java b/src/main/java/org/apache/commons/io/IOUtils.java
index e263e118c..cb375e07b 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -81,11 +81,11 @@
* This class provides static utility methods for input/output operations.
* </p>
* <ul>
- * <li>closeQuietly - these methods close a stream ignoring nulls and exceptions
- * <li>toXxx/read - these methods read data from a stream
- * <li>write - these methods write data to a stream
- * <li>copy - these methods copy all the data from one stream to another
- * <li>contentEquals - these methods compare the content of two streams
+ * <li>closeQuietly - these methods close a stream ignoring nulls and exceptions</li>
+ * <li>toXxx/read - these methods read data from a stream</li>
+ * <li>write - these methods write data to a stream</li>
+ * <li>copy - these methods copy all the data from one stream to another</li>
+ * <li>contentEquals - these methods compare the content of two streams</li>
* </ul>
* <p>
* The byte-to-char methods and char-to-byte methods involve a conversion step.
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
index b2e04c334..7530e3399 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -298,7 +298,7 @@ public int read() throws IOException {
* @return the number of bytes read or {@link IOUtils#EOF EOF} if we reached the end of stream.
* @throws IOException
* <ul>
- * <li>If the first byte cannot be read for any reason other than the end of the file,
+ * <li>If the first byte cannot be read for any reason other than the end of the file,</li>
* <li>if the input stream has been closed, or</li>
* <li>if some other I/O error occurs.</li>
* </ul>
@@ -325,7 +325,7 @@ public int read(final byte[] b) throws IOException {
* @return the number of bytes read or {@link IOUtils#EOF EOF} if we reached the end of stream.
* @throws IOException
* <ul>
- * <li>If the first byte cannot be read for any reason other than the end of the file,
+ * <li>If the first byte cannot be read for any reason other than the end of the file,</li>
* <li>if the input stream has been closed, or</li>
* <li>if some other I/O error occurs.</li>
* </ul>
(commons-io) 02/03: Javadoc: Add missing tags
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 b953e196138234f2295b0a4e12d9c3d8a00520ec
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Dec 13 07:53:18 2025 -0500
Javadoc: Add missing </li> tags
---
src/main/java/org/apache/commons/io/file/PathUtils.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/file/PathUtils.java b/src/main/java/org/apache/commons/io/file/PathUtils.java
index bafcf86ca..6672df7ac 100644
--- a/src/main/java/org/apache/commons/io/file/PathUtils.java
+++ b/src/main/java/org/apache/commons/io/file/PathUtils.java
@@ -499,7 +499,7 @@ public static Path current() {
* </p>
* <ul>
* <li>A directory to delete does not have to be empty.</li>
- * <li>You get exceptions when a file or directory cannot be deleted; {@link File#delete()} returns a boolean.
+ * <li>You get exceptions when a file or directory cannot be deleted; {@link File#delete()} returns a boolean.</li>
* </ul>
*
* @param path file or directory to delete, must not be {@code null}
@@ -518,7 +518,7 @@ public static PathCounters delete(final Path path) throws IOException {
* </p>
* <ul>
* <li>A directory to delete does not have to be empty.</li>
- * <li>You get exceptions when a file or directory cannot be deleted; {@link File#delete()} returns a boolean.
+ * <li>You get exceptions when a file or directory cannot be deleted; {@link File#delete()} returns a boolean.</li>
* </ul>
*
* @param path file or directory to delete, must not be {@code null}
@@ -540,7 +540,7 @@ public static PathCounters delete(final Path path, final DeleteOption... deleteO
* </p>
* <ul>
* <li>A directory to delete does not have to be empty.</li>
- * <li>You get exceptions when a file or directory cannot be deleted; {@link File#delete()} returns a boolean.
+ * <li>You get exceptions when a file or directory cannot be deleted; {@link File#delete()} returns a boolean.</li>
* </ul>
*
* @param path file or directory to delete, must not be {@code null}
(commons-io) 01/03: 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 11c0562b0b0159484fcb412339914f7de498a289
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Dec 13 07:53:04 2025 -0500
Javadoc
---
src/main/java/org/apache/commons/io/IOUtils.java | 46 ++++++++++++------------
1 file changed, 23 insertions(+), 23 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java b/src/main/java/org/apache/commons/io/IOUtils.java
index 8a4057ae5..e263e118c 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -558,11 +558,11 @@ private static char[] charArray(final int size) {
* }
* </code></pre>
*
- * @param array the array against which the range is validated
- * @param off the starting offset into the array (inclusive)
- * @param len the number of elements to access
- * @throws NullPointerException if {@code array} is {@code null}
- * @throws IndexOutOfBoundsException if the range {@code [off, off + len)} is out of bounds for {@code array}
+ * @param array the array against which the range is validated.
+ * @param off the starting offset into the array (inclusive).
+ * @param len the number of elements to access.
+ * @throws NullPointerException if {@code array} is {@code null}.
+ * @throws IndexOutOfBoundsException if the range {@code [off, off + len)} is out of bounds for {@code array}.
* @see InputStream#read(byte[], int, int)
* @see OutputStream#write(byte[], int, int)
* @since 2.21.0
@@ -605,11 +605,11 @@ public static void checkFromIndexSize(final byte[] array, final int off, final i
* }
* </code></pre>
*
- * @param array the array against which the range is validated
- * @param off the starting offset into the array (inclusive)
- * @param len the number of characters to access
- * @throws NullPointerException if {@code array} is {@code null}
- * @throws IndexOutOfBoundsException if the range {@code [off, off + len)} is out of bounds for {@code array}
+ * @param array the array against which the range is validated.
+ * @param off the starting offset into the array (inclusive).
+ * @param len the number of characters to access.
+ * @throws NullPointerException if {@code array} is {@code null}.
+ * @throws IndexOutOfBoundsException if the range {@code [off, off + len)} is out of bounds for {@code array}.
* @see Reader#read(char[], int, int)
* @see Writer#write(char[], int, int)
* @since 2.21.0
@@ -648,11 +648,11 @@ static void checkFromIndexSize(final int off, final int len, final int arrayLeng
* }
* </code></pre>
*
- * @param str the string against which the range is validated
- * @param off the starting offset into the string (inclusive)
- * @param len the number of characters to write
- * @throws NullPointerException if {@code str} is {@code null}
- * @throws IndexOutOfBoundsException if the range {@code [off, off + len)} is out of bounds for {@code str}
+ * @param str the string against which the range is validated.
+ * @param off the starting offset into the string (inclusive).
+ * @param len the number of characters to write.
+ * @throws NullPointerException if {@code str} is {@code null}.
+ * @throws IndexOutOfBoundsException if the range {@code [off, off + len)} is out of bounds for {@code str}.
* @see Writer#write(String, int, int)
* @since 2.21.0
*/
@@ -684,10 +684,10 @@ public static void checkFromIndexSize(final String str, final int off, final int
* }
* </code></pre>
*
- * @param seq the character sequence to validate (may be {@code null}, treated as {@code "null"})
- * @param fromIndex the starting index (inclusive)
- * @param toIndex the ending index (exclusive)
- * @throws IndexOutOfBoundsException if the range {@code [fromIndex, toIndex)} is out of bounds for {@code seq}
+ * @param seq the character sequence to validate (may be {@code null}, treated as {@code "null"}).
+ * @param fromIndex the starting index (inclusive).
+ * @param toIndex the ending index (exclusive).
+ * @throws IndexOutOfBoundsException if the range {@code [fromIndex, toIndex)} is out of bounds for {@code seq}.
* @see Appendable#append(CharSequence, int, int)
* @since 2.21.0
*/
@@ -1889,10 +1889,10 @@ public static long copyLarge(final Reader reader, final Writer writer) throws IO
*
* @param reader the {@link Reader} to source.
* @param writer the {@link Writer} to target.
- * @param buffer the buffer to be used for the copy
- * @return the number of characters copied
- * @throws NullPointerException if the input or output is null
- * @throws IOException if an I/O error occurs
+ * @param buffer the buffer to be used for the copy.
+ * @return the number of characters copied.
+ * @throws NullPointerException if the input or output is null.
+ * @throws IOException if an I/O error occurs.
* @since 2.2
*/
public static long copyLarge(final Reader reader, final Writer writer, final char[] buffer) throws IOException {