[commons-io] 06/24: Javadoc

[ggregory]

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

commit 301cbd4b7ec5d9f97fa424b9ddc0ae2327a1b317
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 19 10:37:48 2023 -0400

    Javadoc
---
 .../java/org/apache/commons/io/input/ReaderInputStream.java  | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java 
b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
index a78bd6f8..27ea5ab8 100644
--- a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
@@ -31,6 +31,7 @@ import java.util.Objects;
 
 import org.apache.commons.io.Charsets;
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 import org.apache.commons.io.charset.CharsetEncoders;
 
@@ -103,8 +104,17 @@ public class ReaderInputStream extends InputStream {
 
         /**
          * Constructs a new instance.
+         * <p>
+         * This builder use the aspects Reader, Charset, CharsetEncoder, 
buffer size.
+         * </p>
+         * <p>
+         * You must provide an origin that can be converted to a Reader by 
this builder, otherwise, this call will throw an
+         * {@link UnsupportedOperationException}.
+         * </p>
          *
-         * @throws UnsupportedOperationException if the origin cannot be 
converted to a Reader.
+         * @return a new instance.
+         * @throws UnsupportedOperationException if the origin cannot provide 
a Reader.
+         * @see AbstractOrigin#getReader(Charset)
          */
         @SuppressWarnings("resource")
         @Override