Skip to content

Commit 877b9e3

Browse files
committed
Javadoc
1 parent e47f5ad commit 877b9e3

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,14 @@
2323
import java.util.stream.Stream;
2424

2525
/**
26-
* Wraps and presents a stream as a closable {@link Iterator} resource that automatically closes itself when reaching the end of stream.
26+
* Wraps and presents a {@link Stream} as an {@link AutoCloseable} {@link Iterator} resource that automatically closes itself when reaching the end of stream.
27+
*
2728
* <h2>Warning</h2>
2829
* <p>
2930
* In order to close the stream, the call site MUST either close the stream it allocated OR call the iterator until the end.
3031
* </p>
3132
*
32-
* @param <E> The stream and iterator type.
33+
* @param <E> The {@link Stream} and {@link Iterator} type.
3334
* @since 2.9.0
3435
*/
3536
final class StreamIterator<E> implements Iterator<E>, Closeable {

0 commit comments

Comments
 (0)