You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2021/11/28 15:04:45 UTC

[commons-vfs] branch master updated: Fix Checkstyle JavadocVariable.

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 118964b  Fix Checkstyle JavadocVariable.
118964b is described below

commit 118964bf3660c2f1b0719fb9eecd5d22e3e3a593
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Nov 28 10:04:43 2021 -0500

    Fix Checkstyle JavadocVariable.
---
 .../commons/vfs2/provider/ftps/FtpsMode.java       | 22 ++++++++++++++++++----
 .../provider/http/HttpFileSystemConfigBuilder.java |  6 ++++++
 2 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsMode.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsMode.java
index e08c4c0..8f3ea35 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsMode.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftps/FtpsMode.java
@@ -20,14 +20,28 @@ package org.apache.commons.vfs2.provider.ftps;
  * Mode of the FTPS connection.
  *
  * <p>
- * Note, that 'implicit' mode is not standardized and considered as deprecated. Some unit tests for VFS fail with
- * 'implicit' mode and it is not yet clear if its a problem with Commons VFS/Commons Net or our test server Apache
- * FTP/SSHD.
+ * Note, that implicit mode is not standardized and considered as deprecated. Some unit tests for VFS fail with implicit
+ * mode and it is not yet clear if its a problem with Commons VFS/Commons Net or our test server Apache FTP/SSHD.
  * </p>
  *
  * @see <a href="http://en.wikipedia.org/wiki/FTPS#Implicit">Wikipedia: FTPS/Implicit</a>
  * @since 2.1
  */
 public enum FtpsMode {
-    IMPLICIT, EXPLICIT
+
+    /**
+     * Implicit mode.
+     * <p>
+     * Note, that implicit mode is not standardized and considered as deprecated. Some unit tests for VFS fail with implicit
+     * mode and it is not yet clear if its a problem with Commons VFS/Commons Net or our test server Apache FTP/SSHD.
+     * </p>
+     *
+     * @see <a href="http://en.wikipedia.org/wiki/FTPS#Implicit">Wikipedia: FTPS/Implicit</a>
+     */
+    IMPLICIT,
+
+    /**
+     * Explicit mode.
+     */
+    EXPLICIT
 }
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
index 566176e..30c52af 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/http/HttpFileSystemConfigBuilder.java
@@ -31,8 +31,14 @@ import org.apache.commons.vfs2.UserAuthenticator;
  */
 public class HttpFileSystemConfigBuilder extends FileSystemConfigBuilder {
 
+    /**
+     * Keys for FileSystemOptions.
+     */
     protected static final String KEY_FOLLOW_REDIRECT = "followRedirect";
 
+    /**
+     * Keys for FileSystemOptions.
+     */
     protected static final String KEY_USER_AGENT = "userAgent";
 
     private static final HttpFileSystemConfigBuilder BUILDER = new HttpFileSystemConfigBuilder();