[commons-vfs] branch master updated: VFS-804 - Fix and Refine Javadoc (#174)

[gg...@apache.org]

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-vfs.git


The following commit(s) were added to refs/heads/master by this push:
     new 5a0a8bb  VFS-804 - Fix and Refine Javadoc (#174)
5a0a8bb is described below

commit 5a0a8bbf9a1c2461b938157184318a6c137e7a7a
Author: Arturo Bernal <ar...@gmail.com>
AuthorDate: Sun Mar 28 21:38:54 2021 +0200

    VFS-804 - Fix and Refine Javadoc (#174)
---
 .../apache/commons/vfs2/provider/ram/RamFileObject.java    |  2 +-
 .../apache/commons/vfs2/provider/ram/RamFileSystem.java    | 14 +++++++-------
 .../apache/commons/vfs2/provider/sftp/SftpFileObject.java  |  2 +-
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
index 6b9fad1..d730df5 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileObject.java
@@ -237,7 +237,7 @@ public class RamFileObject extends AbstractFileObject<RamFileSystem> {
     }
 
     /**
-     * @param newSize
+     * @param newSize The new buffer size.
      * @throws IOException if the new size exceeds the limit
      */
     synchronized void resize(final long newSize) throws IOException {
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
index 30c22a0..b2ec0ba 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileSystem.java
@@ -102,8 +102,8 @@ public class RamFileSystem extends AbstractFileSystem implements Serializable {
     /**
      * Delete a file
      *
-     * @param file
-     * @throws FileSystemException
+     * @param file the {@link RamFileObject} file to delete.
+     * @throws FileSystemException Thrown for file system errors.
      */
     void delete(final RamFileObject file) throws FileSystemException {
         // root is read only check
@@ -123,8 +123,8 @@ public class RamFileSystem extends AbstractFileSystem implements Serializable {
     /**
      * Saves a file
      *
-     * @param file
-     * @throws FileSystemException
+     * @param file the {@link RamFileObject} file to save.
+     * @throws FileSystemException Thrown for file system errors.
      */
     void save(final RamFileObject file) throws FileSystemException {
 
@@ -193,9 +193,9 @@ public class RamFileSystem extends AbstractFileSystem implements Serializable {
     /**
      * Import the given file with the name relative to the given root
      *
-     * @param fo
-     * @param root
-     * @throws FileSystemException
+     * @param fo the source {@link FileObject} file to import.
+     * @param root the {@link FileObject} root.
+     * @throws FileSystemException Thrown for file system errors.
      */
     private void toRamFileObject(final FileObject fo, final FileObject root) throws FileSystemException {
         final RamFileObject memFo = (RamFileObject) this
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
index 79ed0e8..2bc3489 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/sftp/SftpFileObject.java
@@ -100,7 +100,7 @@ public class SftpFileObject extends AbstractFileObject<SftpFileSystem> {
     /**
      * Fetches file attributes from server.
      *
-     * @throws IOException
+     * @throws IOException if an error occurs.
      */
     private void statSelf() throws IOException {
         ChannelSftp channelSftp = null;