RFR: 8259218: (fs) Add links in from overloaded methods in java.nio.file.Files

Brian Burkhalter brian.burkhalter at oracle.com
Wed Mar 10 17:06:05 UTC 2021



> On Mar 10, 2021, at 3:41 AM, Daniel Fuchs <dfuchs at openjdk.java.net> wrote:
> 
> src/java.base/share/classes/java/nio/file/Files.java line 2854:
> 
>> 2852:      * <blockquote>{@link
>> 2853:      * walkFileTree(Path, Set<FileVisitOption>, int, FileVisitor<? super Path>)
>> 2854:      * walkFileTree(start, EnumSet.noneOf(FileVisitOption.class), Integer.MAX_VALUE, visitor)
> 
> Because all methods in `Files` are static, and because the text speaks of "evaluating an expression" and is formatted as a code block (rather than as an inline reference), I wonder if you shouldn't add the `Files.` prefix here, and keep it in all the other snippets rather than  removing it.

OK I will put it back for the code block cases.

> Also - doesn't the link target need to start with a hash sign? I mean:
> 
> {@link #walkFileTree(Path, Set<FileVisitOption>, int, FileVisitor<? super Path>)
> … }

No, it does not.

Thanks,

Brian
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/nio-dev/attachments/20210310/d02f883c/attachment-0001.htm>


More information about the nio-dev mailing list