RFR: 8067127: Tags cleanup

Brian Burkhalter bpb at openjdk.java.net
Tue Oct 6 18:25:06 UTC 2020


On Mon, 5 Oct 2020 20:45:54 GMT, Roger Riggs <rriggs 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/PipedReader.java line 62:
> 
>> 60:      * next character of data will be stored when received from the connected
>> 61:      * piped writer. {@code in < 0} implies the buffer is empty,
>> 62:      * {@code in==out} implies the buffer is full
> 
> Add spaces around ==?

Will change before integrating.

> src/java.base/share/classes/java/io/FileFilter.java line 33:
> 
>> 31:  *
>> 32:  * <p> Instances of this interface may be passed to the {@link
>> 33:  * File#listFiles(java.io.FileFilter) listFiles(FileFilter)} method
> 
> I would tend to keep {@link on the same line with the rest of the link.

Will change before integrating.

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

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


More information about the core-libs-dev mailing list