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

Brian Burkhalter bpb at openjdk.org
Tue May 9 15:58:19 UTC 2023


On Tue, 9 May 2023 05:53:12 GMT, Alan Bateman <alanb at openjdk.org> wrote:

>> Brian Burkhalter has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   8307409: Remove incorrect @link in @snippet
>
> src/java.base/share/classes/java/nio/file/FileTreeIterator.java line 39:
> 
>> 37:  * An {@code Iterator} to iterate over the nodes of a file tree.
>> 38:  *
>> 39:  * {@snippet lang=java :
> 
> This is a JDK internal class so the example won't show up in the API docs, just FYI.

> Also some changes were made to package private classes which do not appear in the nominal javadoc.

Right, that was the motivation for my first comment after opening the PR which is excerpted here.

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

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


More information about the nio-dev mailing list