Javadoc: Add missing comments

apache · Dec 24, 2024 · 861188f · 861188f
1 parent 758474e
commit 861188f
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 2 deletions.
diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java
@@ -51,12 +51,21 @@
  * </ul>
  */
 public abstract class AbstractSyncTask extends VfsTask {
+
     /**
      * Information about a source file.
      */
     public static class SourceInfo {
+
         private String file;
 
+        /**
+         * Constructs a new instance.
+         */
+        public SourceInfo() {
+            // empty
+        }
+
         /**
          * Sets the file.
          *
@@ -75,6 +84,13 @@ public void setFile(final String file) {
 
     private String filesList;
 
+    /**
+     * Constructs a new instance.
+     */
+    public AbstractSyncTask() {
+        // empty
+    }
+
     /**
      * Adds a nested &lt;src&gt; element.
      *

diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java
@@ -32,6 +32,13 @@ public class CopyTask extends AbstractSyncTask {
     private boolean overwrite;
     private boolean preserveLastModified = true;
 
+    /**
+     * Constructs a new instance.
+     */
+    public CopyTask() {
+        // empty
+    }
+
     /**
      * Handles an out-of-date file.
      *
@@ -64,13 +71,17 @@ protected void handleUpToDateFile(final FileObject srcFile, final FileObject des
     }
 
     /**
+     * Tests whether overwrite is enabled.
+     *
      * @return the current value of overwrite
      */
     public boolean isOverwrite() {
         return overwrite;
     }
 
     /**
+     * Tests whether preserve last modified is enabled.
+     *
      * @return the current value of preserveLastModified
      */
     public boolean isPreserveLastModified() {
@@ -87,7 +98,7 @@ public void setOverwrite(final boolean overwrite) {
     }
 
     /**
-     * Enable/disable preserving last modified time of copied files.
+     * Sets preserving last modified time of copied files.
      *
      * @param preserveLastModified true if the last modified time should be preserved.
      */

diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java
@@ -29,10 +29,18 @@
  * </p>
  */
 public class DeleteTask extends VfsTask {
+
     private String file;
     private String srcDirUrl;
     private String filesList;
 
+    /**
+     * Constructs a new instance.
+     */
+    public DeleteTask() {
+        // empty
+    }
+
     /**
      * Executes this task.
      *

diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java
@@ -28,6 +28,13 @@ public class MkdirTask extends VfsTask {
 
     private String dirName;
 
+    /**
+     * Constructs a new instance.
+     */
+    public MkdirTask() {
+        // empty
+    }
+
     /**
      * Executes the task.
      *

diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java
@@ -28,8 +28,16 @@
  * </p>
  */
 public class MoveTask extends CopyTask {
+
     private boolean tryRename;
 
+    /**
+     * Constructs a new instance.
+     */
+    public MoveTask() {
+        // empty
+    }
+
     /**
      * Handles a single source file.
      */

diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java
@@ -37,6 +37,13 @@ public class ShowFileTask extends VfsTask {
     private boolean showContent;
     private boolean recursive;
 
+    /**
+     * Constructs a new instance.
+     */
+    public ShowFileTask() {
+        // empty
+    }
+
     /**
      * Executes the task.
      *

diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java
@@ -23,6 +23,13 @@
  */
 public class SyncTask extends CopyTask {
 
+    /**
+     * Constructs a new instance.
+     */
+    public SyncTask() {
+        // empty
+    }
+
     /**
      * Check if this task cares about destination files with a missing source file.
      */

diff --git a/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java b/commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java
@@ -31,6 +31,13 @@
  */
 public class VfsTask extends Task {
 
+    /**
+     * Constructs a new instance.
+     */
+    public VfsTask() {
+        // empty
+    }
+
     /**
      * A commons-logging wrapper for Ant logging.
      */

diff --git a/pom.xml b/pom.xml
@@ -314,8 +314,27 @@
               <head>To Do:</head>
             </tag>
           </tags>
-          <aggregate>true</aggregate>
         </configuration>
+        <reportSets>
+          <reportSet>
+            <id>non-aggregate</id>
+            <configuration>
+              <!-- Specific configuration for the non aggregate report -->
+            </configuration>
+            <reports>
+              <report>javadoc</report>
+            </reports>
+          </reportSet>
+          <reportSet>
+            <id>aggregate</id>
+            <configuration>
+              <!-- Specific configuration for the aggregate report -->
+            </configuration>
+            <reports>
+              <report>aggregate</report>
+            </reports>
+          </reportSet>
+        </reportSets>
       </plugin>
       <plugin>
         <groupId>com.github.spotbugs</groupId>