Fix Javadoc warnings (Java 21)

Author: garydgregory

commons-vfs2/src/main/java/org/apache/commons/vfs2/FileObject.java

@@ -224,7 +224,7 @@ public interface FileObject extends Comparable<FileObject>, Iterable<FileObject>
     void findFiles(FileSelector selector, boolean depthwise, List<FileObject> selected) throws FileSystemException;
 
     /**
-     * Returns a child of this file. Note that this method returns {@code null} when the child does not exist. This
+     * Gets a child of this file. Note that this method returns {@code null} when the child does not exist. This
      * differs from {@link #resolveFile(String, NameScope)} which never returns null.
      *
      * @param name The name of the child.
@@ -235,7 +235,7 @@ public interface FileObject extends Comparable<FileObject>, Iterable<FileObject>
     FileObject getChild(String name) throws FileSystemException;
 
     /**
-     * Lists the children of this file.
+     * Gets a lists of children of this file.
      *
      * @return An array containing the children of this file. The array is unordered. If the file does not have any
      *         children, a zero-length array is returned. This method never returns null.
@@ -245,7 +245,7 @@ public interface FileObject extends Comparable<FileObject>, Iterable<FileObject>
     FileObject[] getChildren() throws FileSystemException;
 
     /**
-     * Returns this file's content. The {@link FileContent} returned by this method can be used to read and write the
+     * Gets this file's content. The {@link FileContent} returned by this method can be used to read and write the
      * content of the file.
      *
      * <p>
@@ -259,35 +259,37 @@ public interface FileObject extends Comparable<FileObject>, Iterable<FileObject>
     FileContent getContent() throws FileSystemException;
 
     /**
+     * Gets this instance's FileOperations.
+     *
      * @return FileOperations interface that provides access to the operations API.
      * @throws FileSystemException if an error occurs.
      */
     FileOperations getFileOperations() throws FileSystemException;
 
     /**
-     * Returns the file system that contains this file.
+     * Gets the file system that contains this file.
      *
      * @return The file system.
      */
     FileSystem getFileSystem();
 
     /**
-     * Returns the name of this file.
+     * Gets the name of this file.
      *
      * @return the FileName.
      */
     FileName getName();
 
     /**
-     * Returns the folder that contains this file.
+     * Gets the folder that contains this file.
      *
      * @return The folder that contains this file. Returns null if this file is the root of a file system.
      * @throws FileSystemException On error finding the file's parent.
      */
     FileObject getParent() throws FileSystemException;
 
     /**
-     * Returns a Path representing this file.
+     * Gets a Path representing this file.
      *
      * @return the Path for the file.
      * @since 2.7.0
@@ -297,22 +299,22 @@ default Path getPath() {
     }
 
     /**
-     * Returns the receiver as a URI String for public display, like, without a password.
+     * Gets the receiver as a URI String for public display, like, without a password.
      *
      * @return A URI String without a password, never {@code null}.
      */
     String getPublicURIString();
 
     /**
-     * Returns this file's type.
+     * Gets this file's type.
      *
      * @return One of the {@link FileType} constants. Never returns null.
      * @throws FileSystemException On error determining the file's type.
      */
     FileType getType() throws FileSystemException;
 
     /**
-     * Returns a URI representing this file.
+     * Gets a URI representing this file.
      *
      * @return the URI for the file.
      * @since 2.7.0
@@ -322,7 +324,7 @@ default URI getURI() {
     }
 
     /**
-     * Returns a URL representing this file.
+     * Gets a URL representing this file.
      *
      * @return the URL for the file.
      * @throws FileSystemException if an error occurs.

commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSystemManager.java

@@ -66,6 +66,8 @@ public interface FileSystemManager extends AutoCloseable {
     void addOperationProvider(String scheme, FileOperationProvider operationProvider) throws FileSystemException;
 
     /**
+     * Adds an operation provider.
+     *
      * @see FileSystemManager#addOperationProvider(String, org.apache.commons.vfs2.operations.FileOperationProvider)
      * @param schemes The schemes that will be associated with the provider.
      * @param operationProvider The FileOperationProvider to add.

commons-vfs2/src/main/java/org/apache/commons/vfs2/impl/DefaultFileSystemConfigBuilder.java

@@ -57,9 +57,11 @@ protected Class<? extends FileSystem> getConfigClass() {
     }
 
     /**
+     * Gets the UserAuthenticator parameter.
+     *
      * @see #setUserAuthenticator
      * @param opts The FileSystemOptions.
-     * @return The UserAuthenticator.
+     * @return The UserAuthenticator parameter..
      */
     public UserAuthenticator getUserAuthenticator(final FileSystemOptions opts) {
         return getParam(opts, "userAuthenticator");

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperation.java

@@ -19,6 +19,7 @@
 import org.apache.commons.vfs2.FileObject;
 
 /**
+ * Abstracts implementations of {@link FileOperation}.
  *
  * @since 0.1
  */
@@ -39,7 +40,9 @@ public AbstractFileOperation(final FileObject file) {
     }
 
     /**
-     * @return an instance of FileObject which this FileOperation is operated on.
+     * Gets the instance of FileObject for this FileOperation.
+     *
+     * @return the instance of FileObject for this FileOperation.
      */
     protected FileObject getFileObject() {
         return fileObject;

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/AbstractFileOperationProvider.java

@@ -23,6 +23,7 @@
 import org.apache.commons.vfs2.FileSystemException;
 
 /**
+ * Abstracts implementations of {@link FileOperationProvider}.
  *
  * @since 0.1
  */

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/DefaultFileOperations.java

@@ -25,10 +25,12 @@
 import org.apache.commons.vfs2.FileSystemManager;
 
 /**
+ * The default implementations for {@link FileOperations}.
  *
  * @since 0.1
  */
 public class DefaultFileOperations implements FileOperations {
+
     /**
      */
     private final FileSystemManager fsmanager;
@@ -38,6 +40,7 @@ public class DefaultFileOperations implements FileOperations {
     private final FileObject fileObject;
 
     /**
+     * Constructs a new instance.
      *
      * @param file The file.
      */

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/FileOperations.java

@@ -25,22 +25,29 @@
  * @since 0.1
  */
 public interface FileOperations {
+
     /**
+     * Gets the file operation for the given class.
+     *
      * @param operationClass the operation Class.
-     * @return an operation implementing the given {@code operationClass}
+     * @return an operation implementing the given {@code operationClass}.
      * @throws FileSystemException if an error occurs.
      */
     FileOperation getOperation(Class<? extends FileOperation> operationClass) throws FileSystemException;
 
     /**
-     * @return all operations associated with the fileObject
+     * Gets all operations associated with this instance.
+     *
+     * @return all operations associated with this instance.
      * @throws FileSystemException if an error occurs.
      */
     Class<? extends FileOperation>[] getOperations() throws FileSystemException;
 
     /**
+     * Tests @return whether an operation {@code operationClass} is available.
+     *
      * @param operationClass the operation Class.
-     * @return if an operation {@code operationClass} is available
+     * @return whether an operation {@code operationClass} is available.
      * @throws FileSystemException if an error occurs.
      */
     boolean hasOperation(Class<? extends FileOperation> operationClass) throws FileSystemException;

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsAdd.java

@@ -26,12 +26,14 @@
 public interface VcsAdd extends FileOperation {
 
     /**
+     * Sets whether directories should be created.
      *
      * @param makedir true if directories should be created, false otherwise.
      */
     void setMakedir(boolean makedir);
 
     /**
+     * Sets whether subdirectories should be processed.
      *
      * @param recursive true if subdirectories should be processed.
      */

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCheckout.java

@@ -27,24 +27,29 @@
 public interface VcsCheckout extends FileOperation {
 
     /**
-     * @param export if true, administrative .svn directories will not be created on the retrieved tree. The checkout
-     *        operation in this case is equivalent to export function.
+     * Sets whether administrative .svn directories will not be created on the retrieved tree. The checkout operation in this case is equivalent to export
+     * function.
+     *
+     * @param export if true, administrative .svn directories will not be created on the retrieved tree.
      */
     void setExport(boolean export);
 
     /**
+     * Sets whether directories should be traversed.
      *
      * @param recursive true if directories should be traversed.
      */
     void setRecursive(boolean recursive);
 
     /**
+     * Sets the revision number.
      *
      * @param revision The revision number.
      */
     void setRevision(long revision);
 
     /**
+     * Sets directory under which retrieved files should be placed.
      *
      * @param targetDir directory under which retrieved files should be placed.
      */

commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommit.java

@@ -26,24 +26,28 @@
 public interface VcsCommit extends FileOperation {
 
     /**
+     * Sets the listener that is given control when a commit occurs.
      *
      * @param listener Listener that is given control when a commit occurs.
      */
     void addCommitListener(VcsCommitListener listener);
 
     /**
+     * Removes the listener that is given control when a commit occurs.
      *
      * @param listener The Listener.
      */
     void removeCommitListener(VcsCommitListener listener);
 
     /**
+     * Sets the message.
      *
      * @param message The message.
      */
     void setMessage(String message);
 
     /**
+     * Sets whether directories should be traversed.
      *
      * @param isRecursive true if directories should be traversed.
      */