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:26 UTC
(commons-io) 03/03: Fix malformed Javadoc comments
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>