(commons-io) branch master updated: Better Javadoc

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git


The following commit(s) were added to refs/heads/master by this push:
     new 0bc1f4839 Better Javadoc
0bc1f4839 is described below

commit 0bc1f48390191e5d0450da13e1582eb97fb9a8b4
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue May 7 09:56:00 2024 -0400

    Better Javadoc
---
 src/main/java/org/apache/commons/io/file/PathUtils.java | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/io/file/PathUtils.java 
b/src/main/java/org/apache/commons/io/file/PathUtils.java
index 6db7515ef..36b080761 100644
--- a/src/main/java/org/apache/commons/io/file/PathUtils.java
+++ b/src/main/java/org/apache/commons/io/file/PathUtils.java
@@ -1421,13 +1421,14 @@ public final class PathUtils {
     }
 
     /**
-     * Reads the given path as a String.
+     * Reads the file contents at the given path as a String using the Charset.
      *
      * @param path    The source path.
      * @param charset How to convert bytes to a String, null uses the default 
Charset.
-     * @return a new String.
+     * @return the file contents as a new String.
      * @throws IOException if an I/O error occurs reading from the stream.
      * @see Files#readAllBytes(Path)
+     * @see Charsets#toCharset(Charset)
      * @since 2.12.0
      */
     public static String readString(final Path path, final Charset charset) 
throws IOException {