RFR: 8067127: Tags cleanup

Daniel Fuchs dfuchs at openjdk.java.net
Tue Oct 6 18:48:08 UTC 2020


On Mon, 5 Oct 2020 18:59:00 GMT, Brian Burkhalter <bpb at openjdk.org> wrote:

> Please review this change to update some javadoc tags in the java.io package. The changes are to replace some
> occurrences of <code>some_code</code> with {@code some_code}. Not all such constructs were replaced as being
> infeasible, e.g., tag contains an entity such as <code>*/</code> (DataOutput, Serial), or multiple {@code} tags
> would be needed or the result would be ugly (File). It is unclear whether some of the changes which remove the
> non-breaking space entity ( ) are desirable.  Thanks,  Brian

src/java.base/share/classes/java/io/BufferedInputStream.java line 398:

> 396:      * This method returns the sum of the number of bytes remaining to be read in
> 397:      * the buffer ({@code count - pos}) and the result of calling the
> 398:      * {@link java.io.FilterInputStream#in in}.available().

I believe this should probably preferably be:

` * {@link java.io.FilterInputStream#in in}{@code .available()}.`

since `.available()` is obviously code.

-------------

PR: https://git.openjdk.java.net/jdk/pull/513


More information about the core-libs-dev mailing list