Javadoc

Author: garydgregory

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

@@ -98,26 +98,24 @@ public class BOMInputStream extends ProxyInputStream {
 
     /**
      * Builds a new {@link BOMInputStream} instance.
-     * <h2>
-     * Using NIO
-     * </2>
+     *
+     * <h2>Using NIO</h2>
      * <pre>{@code
      * BOMInputStream s = BOMInputStream.builder()
      *   .setPath(Paths.get("MyFile.xml"))
      *   .setByteOrderMarks(ByteOrderMark.UTF_8)
      *   .setInclude(false)
-     *   .get()}
+     *   .get();}
      * </pre>
-     * <h2>
-     * Using IO
-     * </2>
+     * <h2>Using IO</h2>
      * <pre>{@code
      * BOMInputStream s = BOMInputStream.builder()
      *   .setFile(new File("MyFile.xml"))
      *   .setByteOrderMarks(ByteOrderMark.UTF_8)
      *   .setInclude(false)
-     *   .get()}
+     *   .get();}
      * </pre>
+     *
      * @since 2.12.0
      */
     public static class Builder extends AbstractStreamBuilder<BOMInputStream, Builder> {

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

@@ -52,7 +52,7 @@ public final class BufferedFileChannelInputStream extends InputStream {
      * BufferedFileChannelInputStream s = BufferedFileChannelInputStream.builder()
      *   .setFile(file)
      *   .setBufferSize(4096)
-     *   .get()}
+     *   .get();}
      * </pre>
      * <p>
      * Using NIO Path:
@@ -62,7 +62,7 @@ public final class BufferedFileChannelInputStream extends InputStream {
      * BufferedFileChannelInputStream s = BufferedFileChannelInputStream.builder()
      *   .setPath(path)
      *   .setBufferSize(4096)
-     *   .get()}
+     *   .get();}
      * </pre>
      *
      * @since 2.12.0

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

@@ -55,8 +55,9 @@ public class CharSequenceInputStream extends InputStream {
      *   .setBufferSize(8192)
      *   .setCharSequence("String")
      *   .setCharsetEncoder(Charset.defaultCharset())
-     *   .get()}
+     *   .get();}
      * </pre>
+     *
      * @since 2.13.0
      */
     public static class Builder extends AbstractStreamBuilder<CharSequenceInputStream, Builder> {

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

@@ -45,15 +45,24 @@
  * <p>
  * To build an instance, see {@link Builder}.
  * </p>
- * <pre>
- * new BufferedInputStream(new GzipInputStream(new MemoryMappedFileInputStream(path))))
+ * <pre>{@code
+ * BufferedInputStream s = new BufferedInputStream(new GzipInputStream(MemoryMappedFileInputStream.builder()
+ *   .setPath(path)
+ *   .setBufferSize(256 * 1024)
+ *   .get()));}
  * </pre>
  * <p>
  * should outperform:
  * </p>
  * <pre>
  * new GzipInputStream(new MemoryMappedFileInputStream(path))
  * </pre>
+ * <pre>{@code
+ * GzipInputStream s = new GzipInputStream(MemoryMappedFileInputStream.builder()
+ *   .setPath(path)
+ *   .setBufferSize(256 * 1024)
+ *   .get());}
+ * </pre>
  *
  * @since 2.12.0
  */
@@ -68,9 +77,9 @@ public final class MemoryMappedFileInputStream extends InputStream {
      * MemoryMappedFileInputStream s = MemoryMappedFileInputStream.builder()
      *   .setPath(path)
      *   .setBufferSize(256 * 1024)
-     *   .get()}
+     *   .get();}
      * </pre>
-     * <p>
+     *
      * @since 2.12.0
      */
     public static class Builder extends AbstractStreamBuilder<MemoryMappedFileInputStream, Builder> {

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

@@ -52,9 +52,9 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream {
      * MessageDigestCalculatingInputStream s = MessageDigestCalculatingInputStream.builder()
      *   .setPath(path)
      *   .setMessageDigest("SHA-512")
-     *   .get()}
+     *   .get();}
      * </pre>
-     * <p>
+     *
      * @since 2.12.0
      */
     public static class Builder extends AbstractStreamBuilder<MessageDigestCalculatingInputStream, Builder> {

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

@@ -71,9 +71,8 @@ public class QueueInputStream extends InputStream {
      * QueueInputStream s = QueueInputStream.builder()
      *   .setBlockingQueue(new LinkedBlockingQueue<>())
      *   .setTimeout(Duration.ZERO)
-     *   .get()}
+     *   .get();}
      * </pre>
-     * <p>
      *
      * @since 2.12.0
      */

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

@@ -43,9 +43,9 @@ public class RandomAccessFileInputStream extends InputStream {
      * RandomAccessFileInputStream s = RandomAccessFileInputStream.builder()
      *   .setPath(path)
      *   .setCloseOnClose(true)
-     *   .get()}
+     *   .get();}
      * </pre>
-     * <p>
+     *
      * @since 2.12.0
      */
     public static class Builder extends AbstractStreamBuilder<RandomAccessFileInputStream, Builder> {

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

@@ -57,9 +57,9 @@ public class ReadAheadInputStream extends FilterInputStream {
      * ReadAheadInputStream s = ReadAheadInputStream.builder()
      *   .setPath(path)
      *   .setExecutorService(Executors.newSingleThreadExecutor(ReadAheadInputStream::newThread))
-     *   .get()}
+     *   .get();}
      * </pre>
-     * <p>
+     *
      * @since 2.12.0
      */
     public static class Builder extends AbstractStreamBuilder<ReadAheadInputStream, Builder> {

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

@@ -89,9 +89,9 @@ public class ReaderInputStream extends InputStream {
      * ReaderInputStream s = ReaderInputStream.builder()
      *   .setPath(path)
      *   .setCharsetEncoder(Charset.defaultCharset().newEncoder())
-     *   .get()}
+     *   .get();}
      * </pre>
-     * <p>
+     *
      * @since 2.12.0
      */
     public static class Builder extends AbstractStreamBuilder<ReaderInputStream, Builder> {

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

@@ -58,9 +58,9 @@ public class ReversedLinesFileReader implements Closeable {
      *   .setPath(path)
      *   .setBufferSize(4096)
      *   .setCharset(StandardCharsets.UTF_8)
-     *   .get()}
+     *   .get();}
      * </pre>
-     * <p>
+     *
      * @since 2.12.0
      */
     public static class Builder extends AbstractStreamBuilder<ReversedLinesFileReader, Builder> {