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

[Daniel Fuchs]

On Wed, 10 Mar 2021 03:12:31 GMT, Brian Burkhalter <bpb at openjdk.org> wrote:

> Please review this proposed change to make it simpler to navigate to a principal method from a convenience method.
> 
> This change does not appear to rise to the level of requiring a CSR as it involves changes such as `<pre>invocation</pre>` and `{@code invocation}` to `{@link target invocation}`.

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.
Also - doesn't the link target need to start with a hash sign? I mean:

{@link #walkFileTree(Path, Set<FileVisitOption>, int, FileVisitor<? super Path>)
 ... }

best regards,

-- daniel

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

PR: https://git.openjdk.java.net/jdk/pull/2904