Skip to content

Commit 7530557

Browse files
committed
Javadoc
More precise documentation.
1 parent a795283 commit 7530557

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

src/main/java/org/apache/commons/io/output/NullOutputStream.java

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
/**
2323
* Never writes data. Calls never go beyond this class.
2424
* <p>
25-
* This output stream has no destination (file/socket etc.) and all bytes written to it are ignored and lost.
25+
* This output stream has no destination (file/socket etc.) and all bytes written to it are ignored.
2626
* </p>
2727
*/
2828
public class NullOutputStream extends OutputStream {
@@ -44,46 +44,48 @@ public class NullOutputStream extends OutputStream {
4444

4545
/**
4646
* Deprecated in favor of {@link #INSTANCE}.
47-
*
47+
* <p>
4848
* TODO: Will be private in 3.0.
49+
* </p>
4950
*
5051
* @deprecated Use {@link #INSTANCE}.
5152
*/
5253
@Deprecated
5354
public NullOutputStream() {
55+
// empty
5456
}
5557

5658
/**
57-
* Does nothing - output to {@code /dev/null}.
59+
* Does nothing.
5860
*
59-
* @param b The bytes to write
60-
* @throws IOException never
61+
* @param b The This method ignored this parameter.
62+
* @throws IOException This method never throws any exceptions.
6163
*/
6264
@Override
6365
public void write(final byte[] b) throws IOException {
64-
// To /dev/null
66+
// noop
6567
}
6668

6769
/**
68-
* Does nothing - output to {@code /dev/null}.
70+
* Does nothing.
6971
*
70-
* @param b The bytes to write
71-
* @param off The start offset
72-
* @param len The number of bytes to write
72+
* @param b This method ignored this parameter.
73+
* @param off This method ignored this parameter.
74+
* @param len This method ignored this parameter.
7375
*/
7476
@Override
7577
public void write(final byte[] b, final int off, final int len) {
76-
// To /dev/null
78+
// noop
7779
}
7880

7981
/**
80-
* Does nothing - output to {@code /dev/null}.
82+
* Does nothing.
8183
*
82-
* @param b The byte to write
84+
* @param b This method ignored this parameter.
8385
*/
8486
@Override
8587
public void write(final int b) {
86-
// To /dev/null
88+
// noop
8789
}
8890

8991
}

0 commit comments

Comments
 (0)