Javadoc

Author: garydgregory

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

@@ -23,24 +23,25 @@
 import java.util.stream.Stream;
 
 /**
- * Wraps and presents a stream as a closable iterator resource that automatically closes itself when reaching the end
- * of stream.
+ * Wraps and presents a stream as a closable {@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.
  * @since 2.9.0
  */
 final class StreamIterator<E> implements Iterator<E>, Closeable {
 
     /**
-     * Wraps and presents a stream as a closable resource that automatically closes itself when reaching the end of
-     * stream.
+     * Wraps and presents a stream as a closable 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.
+     * 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 <T> The stream and iterator type.
+     * @param <T>    The stream and iterator type.
      * @param stream The stream iterate.
      * @return A new iterator.
      */