You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/08/06 13:34:58 UTC
(commons-io) 08/10: Javadoc
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 07f1df648bf3e77ce2d07d7dd8c0cf2e87545440
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Aug 6 09:02:54 2024 -0400
Javadoc
---
.../java/org/apache/commons/io/input/ProxyInputStream.java | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
index 6b7c68ebb..098fe39ef 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -206,7 +206,7 @@ public abstract class ProxyInputStream extends FilterInputStream {
/**
* Invokes the delegate's {@link InputStream#read()} method unless the stream is closed.
*
- * @return the byte read or -1 if the end of stream
+ * @return the byte read or {@link IOUtils#EOF EOF} if the end of stream
* @throws IOException if an I/O error occurs.
*/
@Override
@@ -229,7 +229,7 @@ public abstract class ProxyInputStream extends FilterInputStream {
* Invokes the delegate's {@link InputStream#read(byte[])} method.
*
* @param b the buffer to read the bytes into
- * @return the number of bytes read or EOF if the end of stream
+ * @return the number of bytes read or {@link IOUtils#EOF EOF} if the end of stream
* @exception IOException
* <ul>
* <li>If the first byte cannot be read for any reason other than the end of the file,
@@ -256,7 +256,7 @@ public abstract class ProxyInputStream extends FilterInputStream {
* @param b the buffer to read the bytes into
* @param off The start offset
* @param len The number of bytes to read
- * @return the number of bytes read or -1 if the end of stream
+ * @return the number of bytes read or {@link IOUtils#EOF EOF} if the end of stream
* @throws IOException if an I/O error occurs.
*/
@Override
@@ -313,11 +313,12 @@ public abstract class ProxyInputStream extends FilterInputStream {
}
/**
- * Unwraps this instance by returning the underlying InputStream.
+ * Unwraps this instance by returning the underlying {@link InputStream}.
* <p>
- * Use with caution; useful to query the underlying InputStream.
+ * Use with caution; useful to query the underlying {@link InputStream}.
* </p>
- * @return the underlying InputStream.
+ *
+ * @return the underlying {@link InputStream}.
* @since 2.16.0
*/
public InputStream unwrap() {