RFR: 8308016: Use snippets in java.io package [v7]

[Brian Burkhalter]

On Thu, 18 May 2023 18:23:53 GMT, Roger Riggs <rriggs at openjdk.org> wrote:

>> Brian Burkhalter has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains seven additional commits since the last revision:
>> 
>>  - Merge
>>  - 8308016: Reinstate @snippet for RandomAccessFile::readLong
>>  - 8308016: Reduce linking in File::toPath snippet
>>  - 8308016: Fix link in snippet of File::toPath
>>  - 8308016: Address reviewer comments since previous commit
>>  - 8308016: Remove ellipses ("...") from snippets
>>  - 8308016: Use snippets in java.io package
>
> src/java.base/share/classes/java/io/ByteArrayOutputStream.java line 284:
> 
>> 282:      * array such that:
>> 283:      * {@snippet lang=java :
>> 284:      *         c == (char)(((hibyte & 0xff) << 8) | (b & 0xff))
> 
> I'd skip the extra indentation for just the single line example.

So changed in b6abb2e40fe574f40ebdfc0c5b1e28ed4b09126e.

> src/java.base/share/classes/java/io/CharArrayWriter.java line 189:
> 
>> 187:      *
>> 188:      * {@snippet lang=java :
>> 189:      *     out.write(csq.subSequence(start, end).toString())
> 
> a trailing ";' would be useful for copy/paste; butr that's not the existing style.  Your call.

These statements in general do not have a trailing `;`; left unchanged.

> src/java.base/share/classes/java/io/Console.java line 125:
> 
>> 123:      *             Scanner sc = new Scanner(con.reader());
>> 124:      *             code: // @replace substring="code:" replacement="..."
>> 125:      *         }
> 
> 4 space indentation would be enough.

So changed in b6abb2e40fe574f40ebdfc0c5b1e28ed4b09126e.

> src/java.base/share/classes/java/io/RandomAccessFile.java line 762:
> 
>> 760:      * then the result is:
>> 761:      * {@snippet lang=java :
>> 762:      *         (byte)(b)
> 
> 4 space indent is sufficient in this file

So changed in b6abb2e40fe574f40ebdfc0c5b1e28ed4b09126e.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/13957#discussion_r1198203067
PR Review Comment: https://git.openjdk.org/jdk/pull/13957#discussion_r1198203673
PR Review Comment: https://git.openjdk.org/jdk/pull/13957#discussion_r1198204033
PR Review Comment: https://git.openjdk.org/jdk/pull/13957#discussion_r1198203822