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 877b9e3f Javadoc
877b9e3f is described below
commit 877b9e3f5e553f8ad988b89b8adb6b93fa97a964
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Oct 5 08:14:54 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/StreamIterator.java | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/StreamIterator.java
b/src/main/java/org/apache/commons/io/StreamIterator.java
index fe086c98..a7491343 100644
--- a/src/main/java/org/apache/commons/io/StreamIterator.java
+++ b/src/main/java/org/apache/commons/io/StreamIterator.java
@@ -23,13 +23,14 @@ import java.util.Objects;
import java.util.stream.Stream;
/**
- * Wraps and presents a stream as a closable {@link Iterator} resource that
automatically closes itself when reaching the end of stream.
+ * Wraps and presents a {@link Stream} as an {@link AutoCloseable} {@link
Iterator} resource that automatically closes itself when reaching the end of
stream.
+ *
* <h2>Warning</h2>
* <p>
* In order to close the stream, the call site MUST either close the stream it
allocated OR call the iterator until the end.
* </p>
*
- * @param <E> The stream and iterator type.
+ * @param <E> The {@link Stream} and {@link Iterator} type.
* @since 2.9.0
*/
final class StreamIterator<E> implements Iterator<E>, Closeable {
