[commons-io] branch master updated: Javadoc nits.

[gg...@apache.org]

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 059a07c  Javadoc nits.
059a07c is described below

commit 059a07c12cd5ba11ea6318777699fbf56e6103c1
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Aug 18 15:39:59 2020 -0400

    Javadoc nits.
---
 .../org/apache/commons/io/input/ObservableInputStream.java | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
index c2aaf47..95a9fe3 100644
--- a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
@@ -43,7 +43,8 @@ public class ObservableInputStream extends ProxyInputStream {
      */
     public static abstract class Observer {
 
-        /** Called to indicate, that {@link InputStream#read()} has been invoked
+        /** 
+         * Called to indicate, that {@link InputStream#read()} has been invoked
          * on the {@link ObservableInputStream}, and will return a value.
          * @param pByte The value, which is being returned. This will never be -1 (EOF),
          *    because, in that case, {@link #finished()} will be invoked instead.
@@ -53,7 +54,8 @@ public class ObservableInputStream extends ProxyInputStream {
             // noop
         }
 
-        /** Called to indicate, that {@link InputStream#read(byte[])}, or
+        /** 
+         * Called to indicate that {@link InputStream#read(byte[])}, or
          * {@link InputStream#read(byte[], int, int)} have been called, and are about to
          * invoke data.
          * @param pBuffer The byte array, which has been passed to the read call, and where
@@ -66,7 +68,8 @@ public class ObservableInputStream extends ProxyInputStream {
             // noop
         }
 
-        /** Called to indicate, that EOF has been seen on the underlying stream.
+        /** 
+         * Called to indicate that EOF has been seen on the underlying stream.
          * This method may be called multiple times, if the reader keeps invoking
          * either of the read methods, and they will consequently keep returning
          * EOF.
@@ -76,7 +79,8 @@ public class ObservableInputStream extends ProxyInputStream {
             // noop
         }
 
-        /** Called to indicate, that the {@link ObservableInputStream} has been closed.
+        /** 
+         * Called to indicate that the {@link ObservableInputStream} has been closed.
          * @throws IOException if an i/o-error occurs
          */
         public void closed() throws IOException {
@@ -84,7 +88,7 @@ public class ObservableInputStream extends ProxyInputStream {
         }
 
         /**
-         * Called to indicate, that an error occurred on the underlying stream.
+         * Called to indicate that an error occurred on the underlying stream.
          * @param pException the exception to throw
          * @throws IOException if an i/o-error occurs
          */