Javadoc: Add missing comments

apache · Dec 24, 2024 · 4c63896 · 4c63896
1 parent eb68ced
commit 4c63896
Show file tree

Hide file tree

Showing 13 changed files with 17 additions and 2 deletions.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsAdd.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsAdd.java
@@ -19,6 +19,7 @@
 import org.apache.commons.vfs2.operations.FileOperation;
 
 /**
+ * The VCS add file operation.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCheckout.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCheckout.java
@@ -20,6 +20,7 @@
 import org.apache.commons.vfs2.operations.FileOperation;
 
 /**
+ * The VCS checkout file operation.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommit.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommit.java
@@ -19,6 +19,7 @@
 import org.apache.commons.vfs2.operations.FileOperation;
 
 /**
+ * The VCS commit file operation.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommitListener.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsCommitListener.java
@@ -17,6 +17,7 @@
 package org.apache.commons.vfs2.operations.vcs;
 
 /**
+ * The VCS commit listener.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsDelete.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsDelete.java
@@ -19,6 +19,7 @@
 import org.apache.commons.vfs2.operations.FileOperation;
 
 /**
+ * The VCS delete file operation.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLog.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLog.java
@@ -19,6 +19,7 @@
 import org.apache.commons.vfs2.operations.FileOperation;
 
 /**
+ * The VCS log file operation.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntry.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntry.java
@@ -19,6 +19,7 @@
 import java.util.Calendar;
 
 /**
+ * A VFS log entry.
  *
  * @since 0.1
  */
@@ -66,6 +67,7 @@ public VcsLogEntry(final String author, final long revision, final String messag
     }
 
     /**
+     * Gets the author.
      *
      * @return The author.
      */
@@ -74,6 +76,7 @@ public String getAuthor() {
     }
 
     /**
+     * Gets the date.
      *
      * @return The date.
      */
@@ -82,6 +85,7 @@ public Calendar getDate() {
     }
 
     /**
+     * Gets the message.
      *
      * @return The message.
      */
@@ -90,6 +94,7 @@ public String getMessage() {
     }
 
     /**
+     * Gets the path.
      *
      * @return The path.
      */
@@ -98,6 +103,7 @@ public String getPath() {
     }
 
     /**
+     * Gets the revision.
      *
      * @return The revision.
      */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntryHandler.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsLogEntryHandler.java
@@ -19,6 +19,7 @@
 import org.apache.commons.vfs2.FileSystemException;
 
 /**
+ * Handles VCS log entries.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsModifyListener.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsModifyListener.java
@@ -17,6 +17,7 @@
 package org.apache.commons.vfs2.operations.vcs;
 
 /**
+ * Handles VFS file modifications.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsRevert.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsRevert.java
@@ -19,10 +19,8 @@
 import org.apache.commons.vfs2.operations.FileOperation;
 
 /**
- * <p>
  * Restores pristine working copy file and cancels all local modifications. In other words, VcsRevert replaces working
  * copy file with the latest version from the repository.
- * </p>
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsStatus.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsStatus.java
@@ -17,6 +17,7 @@
 package org.apache.commons.vfs2.operations.vcs;
 
 /**
+ * Enumerates VFS status.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdate.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdate.java
@@ -19,6 +19,7 @@
 import org.apache.commons.vfs2.operations.FileOperation;
 
 /**
+ * The VCS update file operation.
  *
  * @since 0.1
  */

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdateListener.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdateListener.java
@@ -17,6 +17,7 @@
 package org.apache.commons.vfs2.operations.vcs;
 
 /**
+ * Handles VCS updates.
  *
  * @since 0.1
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -19,6 +19,7 @@ @@
     import org.apache.commons.vfs2.operations.FileOperation;
     /**
+     * The VCS add file operation.
      *
      * @since 0.1
      */
@@ Expand Down @@