RFR JDK-8067127: Tags cleanup
Pavel Rappo
pavel.rappo at oracle.com
Wed Dec 10 14:38:55 UTC 2014
Hi everyone,
Could you please review my change for JDK-8067127?
http://cr.openjdk.java.net/~prappo/8067127/webrev.00/
http://cr.openjdk.java.net/~prappo/8067127/specdiff.00/java/io/package-summary.html
--------------------------------------------------------------------------
The purpose of this cleanup will be appreciated by people who mostly reads
javadoc in-place (in the file) and find this:
* <p> The first byte read is stored into element {@code b[off]}, the next
* one into {@code b[off+1]}, and so on. The number of bytes read is, at
* most, equal to {@code len}. Let {@code k} be the number of bytes actually
* read; these bytes will be stored in elements {@code b[off]} through
* {@code b[off+k-1]}, leaving elements {@code b[off+k]} through {@code
* b[off+len-1]} unaffected.
a lot more preferable, than this (current version):
* <p> The first byte read is stored into element <code>b[off]</code>, the
* next one into <code>b[off+1]</code>, and so on. The number of bytes read
* is, at most, equal to <code>len</code>. Let <i>k</i> be the number of
* bytes actually read; these bytes will be stored in elements
* <code>b[off]</code> through <code>b[off+</code><i>k</i><code>-1]</code>,
* leaving elements <code>b[off+</code><i>k</i><code>]</code> through
* <code>b[off+len-1]</code> unaffected.
The overall goal of the parent task (JDK-8067126) though is to make it even less
wordy and more readable where possible:
* <p> The first byte read is stored into {@code b[0]}, the next
* one into {@code b[1]}, and so on. The number of bytes read is {@code <=
* b.length}. Let {@code k} be the number of bytes actually read; these
* bytes will be stored in elements {@code b[0]..b[k-1]}, leaving elements
* {@code b[k]..b[b.length-1]} unaffected.
-Pavel
More information about the core-libs-dev
mailing list