8219992: Correct the documentation of PrintWriter to refer System.lineSeparator

[Roger Riggs]

+1

On 06/05/2019 05:38 PM, Lance Andersen wrote:
> looking good Brian...
>> On Jun 5, 2019, at 5:31 PM, Brian Burkhalter <brian.burkhalter at oracle.com> wrote:
>>
>> Updated patch based on CSR feedback:
>>
>> --- a/src/java.base/share/classes/java/io/PrintWriter.java
>> +++ b/src/java.base/share/classes/java/io/PrintWriter.java
>> @@ -704,9 +704,8 @@
>>
>>      /**
>>       * Terminates the current line by writing the line separator string.  The
>> -     * line separator string is defined by the system property
>> -     * {@code line.separator}, and is not necessarily a single newline
>> -     * character ({@code '\n'}).
>> +     * line separator is {@link System#lineSeparator()} and is not necessarily
>> +     * a single newline character ({@code '\n'}).
>>       */
>>      public void println() {
>>          newLine();
>>
>> Thanks,
>>
>> Brian
>>
>>> On Jun 5, 2019, at 1:21 PM, Brian Burkhalter <brian.burkhalter at oracle.com> wrote:
>>>
>>> https://bugs.openjdk.java.net/browse/JDK-8219992 <https://bugs.openjdk.java.net/browse/JDK-8219992>
>>>
>>> Proposed change included below (excluding copyright year update); CSR to follow.
>>>
>>> Thanks,
>>>
>>> Brian
>>>
>>> --- a/src/java.base/share/classes/java/io/PrintWriter.java
>>> +++ b/src/java.base/share/classes/java/io/PrintWriter.java
>>> @@ -704,9 +704,8 @@
>>>
>>>     /**
>>>      * Terminates the current line by writing the line separator string.  The
>>> -     * line separator string is defined by the system property
>>> -     * {@code line.separator}, and is not necessarily a single newline
>>> -     * character ({@code '\n'}).
>>> +     * line separator string is defined by the {@link System#lineSeparator()}
>>> +     * method, and is not necessarily a single newline character ({@code '\n'}).
>>>      */
>>>     public void println() {
>>>
>   <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>
>
>
>