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 4c6389699 Javadoc: Add missing comments
4c6389699 is described below
commit 4c63896991124627d5f7583ba33514511b389810
Author: Gary D. Gregory <[email protected]>
AuthorDate: Tue Dec 24 14:35:40 2024 -0500
Javadoc: Add missing comments
---
.../main/java/org/apache/commons/vfs2/operations/vcs/VcsAdd.java | 1 +
.../java/org/apache/commons/vfs2/operations/vcs/VcsCheckout.java | 1 +
.../main/java/org/apache/commons/vfs2/operations/vcs/VcsCommit.java | 1 +
.../org/apache/commons/vfs2/operations/vcs/VcsCommitListener.java | 1 +
.../main/java/org/apache/commons/vfs2/operations/vcs/VcsDelete.java | 1 +
.../main/java/org/apache/commons/vfs2/operations/vcs/VcsLog.java | 1 +
.../java/org/apache/commons/vfs2/operations/vcs/VcsLogEntry.java | 6 ++++++
.../org/apache/commons/vfs2/operations/vcs/VcsLogEntryHandler.java | 1 +
.../org/apache/commons/vfs2/operations/vcs/VcsModifyListener.java | 1 +
.../main/java/org/apache/commons/vfs2/operations/vcs/VcsRevert.java | 2 --
.../main/java/org/apache/commons/vfs2/operations/vcs/VcsStatus.java | 1 +
.../main/java/org/apache/commons/vfs2/operations/vcs/VcsUpdate.java | 1 +
.../org/apache/commons/vfs2/operations/vcs/VcsUpdateListener.java | 1 +
13 files changed, 17 insertions(+), 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
index 17e18e35a..c1e56f80d 100644
---
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 @@ package org.apache.commons.vfs2.operations.vcs;
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
index bd69e3159..d7fe810db 100644
---
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.FileObject;
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
index 4e61eb4e2..ac1cb5ba2 100644
---
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 @@ package org.apache.commons.vfs2.operations.vcs;
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
index 533c7714d..628405962 100644
---
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
index 9cf694895..3a90e023a 100644
---
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 @@ package org.apache.commons.vfs2.operations.vcs;
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
index 7ec907db9..6d22e9868 100644
---
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 @@ package org.apache.commons.vfs2.operations.vcs;
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
index d3e082de4..803bb6652 100644
---
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 @@ package org.apache.commons.vfs2.operations.vcs;
import java.util.Calendar;
/**
+ * A VFS log entry.
*
* @since 0.1
*/
@@ -66,6 +67,7 @@ public class VcsLogEntry {
}
/**
+ * Gets the author.
*
* @return The author.
*/
@@ -74,6 +76,7 @@ public class VcsLogEntry {
}
/**
+ * Gets the date.
*
* @return The date.
*/
@@ -82,6 +85,7 @@ public class VcsLogEntry {
}
/**
+ * Gets the message.
*
* @return The message.
*/
@@ -90,6 +94,7 @@ public class VcsLogEntry {
}
/**
+ * Gets the path.
*
* @return The path.
*/
@@ -98,6 +103,7 @@ public class VcsLogEntry {
}
/**
+ * 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
index 4f2b17c25..14d5bd514 100644
---
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 @@ package org.apache.commons.vfs2.operations.vcs;
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
index 223173a33..47b568478 100644
---
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
index 747b6f552..eb6072b30 100644
---
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 @@ package org.apache.commons.vfs2.operations.vcs;
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
index a1c5f2c01..ec9c68e6e 100644
---
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
index 716cc4712..940e65519 100644
---
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 @@ package org.apache.commons.vfs2.operations.vcs;
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
index f4b88c2ed..ab06d8b2d 100644
---
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
*/
