8131664: Javadoc for PrintStream is now incorrect

[Lance Andersen]

I think this is OK Brian

> On Jul 16, 2019, at 3:16 PM, Brian Burkhalter <brian.burkhalter at oracle.com> wrote:
> 
> An updated version which includes the suggested change below is at [1] with a diff versus the reviewed version .00 at [2].
> 
> Thanks,
> 
> Brian
> 
> [1] http://cr.openjdk.java.net/~bpb/8131664/webrev.01/ <http://cr.openjdk.java.net/~bpb/8131664/webrev.01/>
> [2] Version .01 vs. version .00
> 
> --- a/src/java.base/share/classes/java/io/PrintStream.java
> +++ b/src/java.base/share/classes/java/io/PrintStream.java
> @@ -141,7 +141,7 @@
>      *
>      * @param  out        The output stream to which values and objects will be
>      *                    printed
> -     * @param  autoFlush  Whether the output buffer will be flushed
> +     * @param  autoFlush  A boolean; if true, the output buffer will be flushed
>      *                    whenever a byte array is written, one of the
>      *                    {@code println} methods is invoked, or a newline
>      *                    character or byte ({@code '\n'}) is written
> @@ -158,7 +158,7 @@
>      *
>      * @param  out        The output stream to which values and objects will be
>      *                    printed
> -     * @param  autoFlush  Whether the output buffer will be flushed
> +     * @param  autoFlush  A boolean; if true, the output buffer will be flushed
>      *                    whenever a byte array is written, one of the
>      *                    {@code println} methods is invoked, or a newline
>      *                    character or byte ({@code '\n'}) is written
> @@ -185,7 +185,7 @@
>      *
>      * @param  out        The output stream to which values and objects will be
>      *                    printed
> -     * @param  autoFlush  Whether the output buffer will be flushed
> +     * @param  autoFlush  A boolean; if true, the output buffer will be flushed
>      *                    whenever a byte array is written, one of the
>      *                    {@code println} methods is invoked, or a newline
>      *                    character or byte ({@code '\n'}) is written
> 
> 
>> On Jul 15, 2019, at 1:55 PM, Brian Burkhalter <brian.burkhalter at oracle.com> wrote:
>> 
>>> The existing autoflush wording looks  like it could use some wordsmithing at some point (as I know we do this a little differently in some of the APIs )
>>> 
>>> - “A boolean”  not sure we need to state this as it is obvious from the declaration.
>> 
>> It looks like here one could change "A boolean; if true,” to simply “Whether”.
>> 
>>> -  Some places in the JDK, we say  True if XXXX; false otherwise.  I am not sure how many APIs after the really early ones  start  with “if true…”
>>> 
>>> Anyways, something to consider for a future todo list I guess :-) 
>> 
>> Might be worth doing. I’ll after any other comments come in.
> 

 <http://oracle.com/us/design/oracle-email-sig-198324.gif>
 <http://oracle.com/us/design/oracle-email-sig-198324.gif> <http://oracle.com/us/design/oracle-email-sig-198324.gif>
 <http://oracle.com/us/design/oracle-email-sig-198324.gif>Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
Oracle Java Engineering 
1 Network Drive 
Burlington, MA 01803
Lance.Andersen at oracle.com <mailto:Lance.Andersen at oracle.com>