RFR: 8307409: Refactor usage examples to use @snippet in the java.nio packages [v3]

Brian Burkhalter bpb at openjdk.org
Tue May 9 21:51:38 UTC 2023


On Mon, 8 May 2023 20:48:50 GMT, Roger Riggs <rriggs at openjdk.org> wrote:

>> Brian Burkhalter has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   8307409: Fix indentation, links in snippets
>
> src/java.base/share/classes/java/nio/X-Buffer.java.template line 2244:
> 
>> 2242:      * {@snippet lang=java :
>> 2243:      * nb.alignmentOffset(0, unitSize) == 0
>> 2244:      * nb.alignmentOffset(nb.limit(), unitSize) == 0
> 
> The indentation (within the files) is inconsistent, I think at 4 spaces might be an improvement.

Fixed in https://github.com/openjdk/jdk/pull/13870/commits/acd62d5ccadd0667b2b08aae9de531adbfdcc8b1.

> src/java.base/share/classes/java/nio/channels/SelectionKey.java line 343:
> 
>> 341:      * <blockquote><pre>{@code
>> 342:      * k.readyOps() & OP_READ != 0
>> 343:      * }</pre></blockquote>
> 
> The blockquote provided some indentation, that might make the example more readable.

Fixed in https://github.com/openjdk/jdk/pull/13870/commits/acd62d5ccadd0667b2b08aae9de531adbfdcc8b1.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/13870#discussion_r1189162696
PR Review Comment: https://git.openjdk.org/jdk/pull/13870#discussion_r1189162598


More information about the nio-dev mailing list