src/java.base/share/classes/java/io/PipedReader.java
changeset 58288 48e480e56aad
parent 58242 94bb65cb37d3
child 58679 9c3209ff7550
--- a/src/java.base/share/classes/java/io/PipedReader.java	Tue Sep 24 10:04:13 2019 +0000
+++ b/src/java.base/share/classes/java/io/PipedReader.java	Tue Sep 24 09:43:43 2019 +0100
@@ -59,7 +59,7 @@
      * The index of the position in the circular buffer at which the
      * next character of data will be stored when received from the connected
      * piped writer. <code>in&lt;0</code> implies the buffer is empty,
-     * <code>in==out</code> implies the buffer is full
+     * {@code in==out} implies the buffer is full
      */
     int in = -1;
 
@@ -70,9 +70,9 @@
     int out = 0;
 
     /**
-     * Creates a <code>PipedReader</code> so
+     * Creates a {@code PipedReader} so
      * that it is connected to the piped writer
-     * <code>src</code>. Data written to <code>src</code>
+     * {@code src}. Data written to {@code src}
      * will then be available as input from this stream.
      *
      * @param      src   the stream to connect to.
@@ -83,9 +83,9 @@
     }
 
     /**
-     * Creates a <code>PipedReader</code> so that it is connected
-     * to the piped writer <code>src</code> and uses the specified
-     * pipe size for the pipe's buffer. Data written to <code>src</code>
+     * Creates a {@code PipedReader} so that it is connected
+     * to the piped writer {@code src} and uses the specified
+     * pipe size for the pipe's buffer. Data written to {@code src}
      * will then be  available as input from this stream.
 
      * @param      src       the stream to connect to.
@@ -101,10 +101,10 @@
 
 
     /**
-     * Creates a <code>PipedReader</code> so
+     * Creates a {@code PipedReader} so
      * that it is not yet {@linkplain #connect(java.io.PipedWriter)
      * connected}. It must be {@linkplain java.io.PipedWriter#connect(
-     * java.io.PipedReader) connected} to a <code>PipedWriter</code>
+     * java.io.PipedReader) connected} to a {@code PipedWriter}
      * before being used.
      */
     public PipedReader() {
@@ -112,11 +112,11 @@
     }
 
     /**
-     * Creates a <code>PipedReader</code> so that it is not yet
+     * Creates a {@code PipedReader} so that it is not yet
      * {@link #connect(java.io.PipedWriter) connected} and uses
      * the specified pipe size for the pipe's buffer.
      * It must be  {@linkplain java.io.PipedWriter#connect(
-     * java.io.PipedReader) connected} to a <code>PipedWriter</code>
+     * java.io.PipedReader) connected} to a {@code PipedWriter}
      * before being used.
      *
      * @param   pipeSize the size of the pipe's buffer.
@@ -136,21 +136,21 @@
 
     /**
      * Causes this piped reader to be connected
-     * to the piped  writer <code>src</code>.
+     * to the piped  writer {@code src}.
      * If this object is already connected to some
-     * other piped writer, an <code>IOException</code>
+     * other piped writer, an {@code IOException}
      * is thrown.
      * <p>
-     * If <code>src</code> is an
-     * unconnected piped writer and <code>snk</code>
+     * If {@code src} is an
+     * unconnected piped writer and {@code snk}
      * is an unconnected piped reader, they
      * may be connected by either the call:
      *
-     * <pre><code>snk.connect(src)</code> </pre>
+     * <pre>{@code snk.connect(src)} </pre>
      * <p>
      * or the call:
      *
-     * <pre><code>src.connect(snk)</code> </pre>
+     * <pre>{@code src.connect(snk)} </pre>
      * <p>
      * The two calls have the same effect.
      *
@@ -219,14 +219,14 @@
     /**
      * Reads the next character of data from this piped stream.
      * If no character is available because the end of the stream
-     * has been reached, the value <code>-1</code> is returned.
+     * has been reached, the value {@code -1} is returned.
      * This method blocks until input data is available, the end of
      * the stream is detected, or an exception is thrown.
      *
-     * @return  the next character of data, or <code>-1</code> if the end of the
+     * @return  the next character of data, or {@code -1} if the end of the
      *          stream is reached.
      * @throws  IOException  if the pipe is
-     *          <a href=PipedInputStream.html#BROKEN> <code>broken</code></a>,
+     *          <a href=PipedInputStream.html#BROKEN> {@code broken}</a>,
      *          {@link #connect(java.io.PipedWriter) unconnected}, closed,
      *          or an I/O error occurs.
      */
@@ -270,20 +270,20 @@
     }
 
     /**
-     * Reads up to <code>len</code> characters of data from this piped
-     * stream into an array of characters. Less than <code>len</code> characters
+     * Reads up to {@code len} characters of data from this piped
+     * stream into an array of characters. Less than {@code len} characters
      * will be read if the end of the data stream is reached or if
-     * <code>len</code> exceeds the pipe's buffer size. This method
+     * {@code len} exceeds the pipe's buffer size. This method
      * blocks until at least one character of input is available.
      *
      * @param      cbuf     the buffer into which the data is read.
      * @param      off   the start offset of the data.
      * @param      len   the maximum number of characters read.
      * @return     the total number of characters read into the buffer, or
-     *             <code>-1</code> if there is no more data because the end of
+     *             {@code -1} if there is no more data because the end of
      *             the stream has been reached.
      * @throws     IOException  if the pipe is
-     *             <a href=PipedInputStream.html#BROKEN> <code>broken</code></a>,
+     *             <a href=PipedInputStream.html#BROKEN> {@code broken}</a>,
      *             {@link #connect(java.io.PipedWriter) unconnected}, closed,
      *             or an I/O error occurs.
      * @throws     IndexOutOfBoundsException {@inheritDoc}
@@ -331,7 +331,7 @@
      * stream is ready if the circular buffer is not empty.
      *
      * @throws     IOException  if the pipe is
-     *             <a href=PipedInputStream.html#BROKEN> <code>broken</code></a>,
+     *             <a href=PipedInputStream.html#BROKEN> {@code broken}</a>,
      *             {@link #connect(java.io.PipedWriter) unconnected}, or closed.
      */
     public synchronized boolean ready() throws IOException {