Skip to content

Commit 16a7be9

Browse files
committed
Use the more modern, compact, and flexible Javadoc "{@code ...}" instead of the HTML "<tt>...</tt>".
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1612034 13f79535-47bb-0310-9956-ffa450edef68
1 parent def9299 commit 16a7be9

3 files changed

Lines changed: 14 additions & 14 deletions

File tree

src/main/java/org/apache/commons/io/input/ReaderInputStream.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
* in a {@link java.io.BufferedReader}.
4545
* <p>
4646
* {@link ReaderInputStream} implements the inverse transformation of {@link java.io.InputStreamReader};
47-
* in the following example, reading from <tt>in2</tt> would return the same byte
48-
* sequence as reading from <tt>in</tt> (provided that the initial byte sequence is legal
47+
* in the following example, reading from {@code in2} would return the same byte
48+
* sequence as reading from {@code in} (provided that the initial byte sequence is legal
4949
* with respect to the charset encoding):
5050
* <pre>
5151
* InputStream in = ...

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@
3939
* The data can be retrieved using <code>toByteArray()</code> and
4040
* <code>toString()</code>.
4141
* <p>
42-
* Closing a <tt>ByteArrayOutputStream</tt> has no effect. The methods in
42+
* Closing a {@code ByteArrayOutputStream} has no effect. The methods in
4343
* this class can be called after the stream has been closed without
44-
* generating an <tt>IOException</tt>.
44+
* generating an {@code IOException}.
4545
* <p>
4646
* This is an alternative implementation of the {@link java.io.ByteArrayOutputStream}
4747
* class. The original implementation only allocates 32 bytes at the beginning.
@@ -215,9 +215,9 @@ public synchronized int size() {
215215
}
216216

217217
/**
218-
* Closing a <tt>ByteArrayOutputStream</tt> has no effect. The methods in
218+
* Closing a {@code ByteArrayOutputStream} has no effect. The methods in
219219
* this class can be called after the stream has been closed without
220-
* generating an <tt>IOException</tt>.
220+
* generating an {@code IOException}.
221221
*
222222
* @throws IOException never (this method should not declare this exception
223223
* but it has to now due to backwards compatibility)

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@
4545
* of the {@link WriterOutputStream}.
4646
* <p>
4747
* {@link WriterOutputStream} implements the inverse transformation of {@link java.io.OutputStreamWriter};
48-
* in the following example, writing to <tt>out2</tt> would have the same result as writing to
49-
* <tt>out</tt> directly (provided that the byte sequence is legal with respect to the
48+
* in the following example, writing to {@code out2} would have the same result as writing to
49+
* {@code out} directly (provided that the byte sequence is legal with respect to the
5050
* charset encoding):
5151
* <pre>
5252
* OutputStream out = ...
@@ -110,9 +110,9 @@ public WriterOutputStream(final Writer writer, final CharsetDecoder decoder) {
110110
* @param writer the target {@link Writer}
111111
* @param decoder the charset decoder
112112
* @param bufferSize the size of the output buffer in number of characters
113-
* @param writeImmediately If <tt>true</tt> the output buffer will be flushed after each
113+
* @param writeImmediately If {@code true} the output buffer will be flushed after each
114114
* write operation, i.e. all available data will be written to the
115-
* underlying {@link Writer} immediately. If <tt>false</tt>, the
115+
* underlying {@link Writer} immediately. If {@code false}, the
116116
* output buffer will only be flushed when it overflows or when
117117
* {@link #flush()} or {@link #close()} is called.
118118
* @since 2.1
@@ -130,9 +130,9 @@ public WriterOutputStream(final Writer writer, final CharsetDecoder decoder, fin
130130
* @param writer the target {@link Writer}
131131
* @param charset the charset encoding
132132
* @param bufferSize the size of the output buffer in number of characters
133-
* @param writeImmediately If <tt>true</tt> the output buffer will be flushed after each
133+
* @param writeImmediately If {@code true} the output buffer will be flushed after each
134134
* write operation, i.e. all available data will be written to the
135-
* underlying {@link Writer} immediately. If <tt>false</tt>, the
135+
* underlying {@link Writer} immediately. If {@code false}, the
136136
* output buffer will only be flushed when it overflows or when
137137
* {@link #flush()} or {@link #close()} is called.
138138
*/
@@ -164,9 +164,9 @@ public WriterOutputStream(final Writer writer, final Charset charset) {
164164
* @param writer the target {@link Writer}
165165
* @param charsetName the name of the charset encoding
166166
* @param bufferSize the size of the output buffer in number of characters
167-
* @param writeImmediately If <tt>true</tt> the output buffer will be flushed after each
167+
* @param writeImmediately If {@code true} the output buffer will be flushed after each
168168
* write operation, i.e. all available data will be written to the
169-
* underlying {@link Writer} immediately. If <tt>false</tt>, the
169+
* underlying {@link Writer} immediately. If {@code false}, the
170170
* output buffer will only be flushed when it overflows or when
171171
* {@link #flush()} or {@link #close()} is called.
172172
*/

0 commit comments

Comments
 (0)