Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8259218

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

    XMLWordPrintable

Details

    • b14
    • x86_64
    • windows_10
    • Not verified

    Description

      A DESCRIPTION OF THE PROBLEM :
      Multiple of the java.nio.file.Files methods have overloads with less parameters for convenience. The documentation for these overloads then often says "is equivalent to methodName". However, in some cases the documentation does not contain a link ({@link } tag) to the referenced method overload with more parameters.
      This makes reading the documentation rather cumbersome because you either have to scroll to find the correct method or use the search for it, both disrupting reading flow.

      Instead the documentation should contain inline links ({@link } tag) to allow the reader to directly navigate to the respective overload.

      Affected methods:
      - walkFileTree(Path, FileVisitor)
      - newBufferedReader​(Path)
      - newBufferedWriter​(Path, OpenOption...)
      - readString​(Path)
      - readAllLines​(Path)
      - write​(Path, Iterable, OpenOption...)
      - writeString​(Path, CharSequence, OpenOption...)
      - walk​(Path, FileVisitOption...)
      - lines(Path)


      Attachments

        Issue Links

          Activity

            People

              bpb Brian Burkhalter
              webbuggrp Webbug Group
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: