Skip to content

Commit 56f1f77

Browse files
committed
Fix malformed Javadoc comments
1 parent b953e19 commit 56f1f77

File tree

5 files changed

+19
-18
lines changed

5 files changed

+19
-18
lines changed

src/changes/changes.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ The <action> type attribute can be add,update,fix,remove.
4949
<!-- FIX -->
5050
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix Apache RAT plugin console warnings.</action>
5151
<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>
52+
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix malformed Javadoc comments.</action>
5253
<!-- ADD -->
5354
<action type="add" dev="ggregory" due-to="Gary Gregory">Add and use IOUtils.closeQuietly(Closeable, Throwable) #818.</action>
5455
<!-- UPDATE -->

src/main/java/org/apache/commons/io/DirectoryWalker.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@
167167
* <ul>
168168
* <li>The decision logic on whether to cancel processing or not.</li>
169169
* <li>Constructing and throwing a {@link CancelException}.</li>
170-
* <li>Custom cancel processing in the {@code handleCancelled()} method.
170+
* <li>Custom cancel processing in the {@code handleCancelled()} method.</li>
171171
* </ul>
172172
* <p>
173173
* Two possible scenarios are envisaged for cancellation:

src/main/java/org/apache/commons/io/FileUtils.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -93,16 +93,16 @@
9393
* Facilities are provided in the following areas:
9494
* </p>
9595
* <ul>
96-
* <li>writing to a file
97-
* <li>reading from a file
98-
* <li>make a directory including parent directories
99-
* <li>copying files and directories
100-
* <li>deleting files and directories
101-
* <li>converting to and from a URL
102-
* <li>listing files and directories by filter and extension
103-
* <li>comparing file content
104-
* <li>file last changed date
105-
* <li>calculating a checksum
96+
* <li>writing to a file</li>
97+
* <li>reading from a file</li>
98+
* <li>make a directory including parent directories</li>
99+
* <li>copying files and directories</li>
100+
* <li>deleting files and directories</li>
101+
* <li>converting to and from a URL</li>
102+
* <li>listing files and directories by filter and extension</li>
103+
* <li>comparing file content</li>
104+
* <li>file last changed date</li>
105+
* <li>calculating a checksum</li>
106106
* </ul>
107107
* <p>
108108
* Note that a specific charset should be specified whenever possible. Relying on the platform default means that the

src/main/java/org/apache/commons/io/IOUtils.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@
8181
* This class provides static utility methods for input/output operations.
8282
* </p>
8383
* <ul>
84-
* <li>closeQuietly - these methods close a stream ignoring nulls and exceptions
85-
* <li>toXxx/read - these methods read data from a stream
86-
* <li>write - these methods write data to a stream
87-
* <li>copy - these methods copy all the data from one stream to another
88-
* <li>contentEquals - these methods compare the content of two streams
84+
* <li>closeQuietly - these methods close a stream ignoring nulls and exceptions</li>
85+
* <li>toXxx/read - these methods read data from a stream</li>
86+
* <li>write - these methods write data to a stream</li>
87+
* <li>copy - these methods copy all the data from one stream to another</li>
88+
* <li>contentEquals - these methods compare the content of two streams</li>
8989
* </ul>
9090
* <p>
9191
* The byte-to-char methods and char-to-byte methods involve a conversion step.

src/main/java/org/apache/commons/io/input/ProxyInputStream.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ public int read() throws IOException {
298298
* @return the number of bytes read or {@link IOUtils#EOF EOF} if we reached the end of stream.
299299
* @throws IOException
300300
* <ul>
301-
* <li>If the first byte cannot be read for any reason other than the end of the file,
301+
* <li>If the first byte cannot be read for any reason other than the end of the file,</li>
302302
* <li>if the input stream has been closed, or</li>
303303
* <li>if some other I/O error occurs.</li>
304304
* </ul>
@@ -325,7 +325,7 @@ public int read(final byte[] b) throws IOException {
325325
* @return the number of bytes read or {@link IOUtils#EOF EOF} if we reached the end of stream.
326326
* @throws IOException
327327
* <ul>
328-
* <li>If the first byte cannot be read for any reason other than the end of the file,
328+
* <li>If the first byte cannot be read for any reason other than the end of the file,</li>
329329
* <li>if the input stream has been closed, or</li>
330330
* <li>if some other I/O error occurs.</li>
331331
* </ul>

0 commit comments

Comments
 (0)