JDK 9 RFR of 8154183: (spec) {Data, }InputStream.read(byte[], int, int) - spec of offset argument confusing

[Roger Riggs]

Hi Brian,

Editorial cleanup.
  - In the new @throws NullPointerException and IndexOutOfBoundExceptions,
    the first word after the exception should not be capitalized.
    For example  "if" instead of "If"  makes it consistent with the 
existing doc


DataInputStream:
  - "the start offset in*to* the"  ;  "in" preferred over "into" 
consistent with previous descriptions

ObjectInputStream.java:  line 1012+
  - usually the @throws description is not a complete sentence and does 
not deserve a "."
   per-file-consistency...
   for example,
+     * @throws  NullPointerException If {@code buf} is {@code null}*.

*RandomAccessFile: 433+

  - keep the alignment of the @param lines
  - @throws NPE; remvoe the training "."

Roger

p.s.  There is a new version of webrev that generates convenient next 
and prev file links.


On 4/18/2016 2:37 PM, Brian Burkhalter wrote:
> The patch has been updated in place to replace <code>var</code> with {@code var}, @exception with @throws, and align the text where needed only for the methods in question.
>
> Brian
>
> On Apr 15, 2016, at 3:46 PM, Brian Burkhalter <brian.burkhalter at oracle.com> wrote:
>
>> Re-posted with correct subject line.
>>
>> On Apr 15, 2016, at 3:35 PM, Brian Burkhalter <brian.burkhalter at oracle.com> wrote:
>>
>>> Please review at your convenience.
>>>
>>> Issue:	https://bugs.openjdk.java.net/browse/JDK-8154183
>>> Patch:	http://cr.openjdk.java.net/~bpb/8154183/webrev.00/
>>>
>>> Summary:
>>> 1) Reinstate the ObjectInputStream part of the fixforhttps://bugs.openjdk.java.net/browse/JDK-4150728 which was inadvertently reverted in a subsequent merge.
>>> 2) Apply the same clarifications and addition of missing exception/throws tags to both variants of readFully().