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 91de8ece1e25c92139a7b54dc9de1acdaddb3ce8
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jul 7 13:55:46 2024 -0400
Javadoc
---
.../java/org/apache/commons/io/input/CloseShieldInputStream.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git
a/src/main/java/org/apache/commons/io/input/CloseShieldInputStream.java
b/src/main/java/org/apache/commons/io/input/CloseShieldInputStream.java
index 8ca2e16dd..059e3beba 100644
--- a/src/main/java/org/apache/commons/io/input/CloseShieldInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CloseShieldInputStream.java
@@ -31,10 +31,10 @@ import java.io.InputStream;
public class CloseShieldInputStream extends ProxyInputStream {
/**
- * Constructs a proxy that only shields {@code System.in} from being
closed.
+ * Constructs a proxy that only shields {@link System#in} from closing.
*
- * @param inputStream the input stream to wrap
- * @return the created proxy
+ * @param inputStream the candidate input stream.
+ * @return the given stream or a proxy on {@link System#in}.
* @since 2.17.0
*/
public static InputStream systemIn(final InputStream inputStream) {
