This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch 1.2.X
in repository https://gitbox.apache.org/repos/asf/mina-ftpserver.git
The following commit(s) were added to refs/heads/1.2.X by this push:
new bdc3fa6d Fixed javadoc errors
bdc3fa6d is described below
commit bdc3fa6d3a1e0de5548dda2caf0f370fadafc526
Author: emmanuel lecharny <[email protected]>
AuthorDate: Sun Jan 12 07:12:00 2025 +0100
Fixed javadoc errors
---
.../main/java/org/apache/ftpserver/command/Command.java | 4 ++--
.../main/java/org/apache/ftpserver/command/impl/ABOR.java | 3 ++-
.../main/java/org/apache/ftpserver/command/impl/ACCT.java | 3 ++-
.../main/java/org/apache/ftpserver/command/impl/APPE.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/AUTH.java | 2 +-
.../main/java/org/apache/ftpserver/command/impl/CDUP.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/CWD.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/DELE.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/EPRT.java | 7 +++++--
.../main/java/org/apache/ftpserver/command/impl/EPSV.java | 2 +-
.../main/java/org/apache/ftpserver/command/impl/FEAT.java | 2 +-
.../main/java/org/apache/ftpserver/command/impl/HELP.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/LANG.java | 2 +-
.../main/java/org/apache/ftpserver/command/impl/LIST.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/MD5.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/MDTM.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/MKD.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/MLSD.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/MLST.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/MODE.java | 4 +++-
.../main/java/org/apache/ftpserver/command/impl/NLST.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/NOOP.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/OPTS.java | 4 +++-
.../java/org/apache/ftpserver/command/impl/OPTS_MLST.java | 1 +
.../java/org/apache/ftpserver/command/impl/OPTS_UTF8.java | 1 +
.../main/java/org/apache/ftpserver/command/impl/PASS.java | 4 +++-
.../main/java/org/apache/ftpserver/command/impl/PASV.java | 9 +++++----
.../main/java/org/apache/ftpserver/command/impl/PBSZ.java | 2 +-
.../main/java/org/apache/ftpserver/command/impl/PORT.java | 8 ++++++--
.../main/java/org/apache/ftpserver/command/impl/PROT.java | 2 +-
.../main/java/org/apache/ftpserver/command/impl/PWD.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/QUIT.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/REIN.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/REST.java | 4 +++-
.../main/java/org/apache/ftpserver/command/impl/RETR.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/RMD.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/RNFR.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/RNTO.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/SITE.java | 2 +-
.../org/apache/ftpserver/command/impl/SITE_DESCUSER.java | 2 +-
.../java/org/apache/ftpserver/command/impl/SITE_HELP.java | 2 +-
.../java/org/apache/ftpserver/command/impl/SITE_STAT.java | 2 +-
.../java/org/apache/ftpserver/command/impl/SITE_WHO.java | 2 +-
.../java/org/apache/ftpserver/command/impl/SITE_ZONE.java | 2 +-
.../main/java/org/apache/ftpserver/command/impl/SIZE.java | 3 ++-
.../main/java/org/apache/ftpserver/command/impl/STAT.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/STOR.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/STOU.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/STRU.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/SYST.java | 2 ++
.../main/java/org/apache/ftpserver/command/impl/TYPE.java | 1 +
.../main/java/org/apache/ftpserver/command/impl/USER.java | 2 ++
.../apache/ftpserver/ftpletcontainer/FtpletContainer.java | 6 ++----
.../org/apache/ftpserver/impl/DefaultFtpServerContext.java | 2 +-
.../org/apache/ftpserver/impl/IODataConnectionFactory.java | 2 --
.../main/java/org/apache/ftpserver/listener/Listener.java | 9 ++++-----
.../apache/ftpserver/listener/nio/AbstractListener.java | 3 ++-
.../main/java/org/apache/ftpserver/main/CommandLine.java | 5 ++++-
.../apache/ftpserver/ssl/impl/DefaultSslConfiguration.java | 14 --------------
.../ftpserver/usermanager/impl/AbstractUserManager.java | 2 +-
.../apache/ftpserver/usermanager/impl/DbUserManager.java | 2 +-
.../ftpserver/usermanager/impl/PropertiesUserManager.java | 7 ++++---
.../main/java/org/apache/ftpserver/util/StringUtils.java | 6 +++---
63 files changed, 125 insertions(+), 65 deletions(-)
diff --git a/core/src/main/java/org/apache/ftpserver/command/Command.java
b/core/src/main/java/org/apache/ftpserver/command/Command.java
index 258b3d82..e3284310 100644
--- a/core/src/main/java/org/apache/ftpserver/command/Command.java
+++ b/core/src/main/java/org/apache/ftpserver/command/Command.java
@@ -38,8 +38,8 @@ public interface Command {
* @param session The current {@link FtpIoSession}
* @param context The current {@link FtpServerContext}
* @param request The current {@link FtpRequest}
- * @throws IOException
- * @throws FtpException
+ * @throws IOException If the command failed
+ * @throws FtpException If we've got a FTP error
*/
void execute(FtpIoSession session, FtpServerContext context, FtpRequest
request) throws IOException, FtpException;
}
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/ABOR.java
b/core/src/main/java/org/apache/ftpserver/command/impl/ABOR.java
index bc3cc04c..39bafaaa 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/ABOR.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/ABOR.java
@@ -31,7 +31,9 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>ABOR <CRLF></code><br>
+ * <p>
*
* This command tells the server to abort the previous FTP service command and
* any associated transfer of data. No action is to be taken if the previous
@@ -43,7 +45,6 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
public class ABOR extends AbstractCommand {
-
/**
* Execute command
*
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/ACCT.java
b/core/src/main/java/org/apache/ftpserver/command/impl/ACCT.java
index 4b6ed7fa..56f430ee 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/ACCT.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/ACCT.java
@@ -31,7 +31,9 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>ACCT <CRLF></code><br>
+ * <p>
*
* Acknowledges the ACCT (account) command with a 202 reply. The command
however
* is irrelevant to any workings.
@@ -39,7 +41,6 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
public class ACCT extends AbstractCommand {
-
/**
* Execute command.
*
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/APPE.java
b/core/src/main/java/org/apache/ftpserver/command/impl/APPE.java
index 7ae06024..3da784de 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/APPE.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/APPE.java
@@ -45,7 +45,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>APPE <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command causes the server-DTP to accept the data transferred via the
* data connection and to store the data in a file at the server site. If the
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/AUTH.java
b/core/src/main/java/org/apache/ftpserver/command/impl/AUTH.java
index bfc4ec97..8a592f97 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/AUTH.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/AUTH.java
@@ -41,7 +41,7 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* This server supports explicit SSL support.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/CDUP.java
b/core/src/main/java/org/apache/ftpserver/command/impl/CDUP.java
index 64f5e592..4397deac 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/CDUP.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/CDUP.java
@@ -36,7 +36,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>CDUP <CRLF></code><br>
+ * <p>
*
* This command is a special case of CWD, and is included to simplify the
* implementation of programs for transferring directory trees between
operating
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/CWD.java
b/core/src/main/java/org/apache/ftpserver/command/impl/CWD.java
index 71ee15aa..a73edaf9 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/CWD.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/CWD.java
@@ -36,7 +36,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>CWD <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command allows the user to work with a different directory for file
* storage or retrieval without altering his login or accounting information.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/DELE.java
b/core/src/main/java/org/apache/ftpserver/command/impl/DELE.java
index a4588e11..221de0a8 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/DELE.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/DELE.java
@@ -36,7 +36,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>DELE <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command causes the file specified in the pathname to be deleted at the
* server site.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/EPRT.java
b/core/src/main/java/org/apache/ftpserver/command/impl/EPRT.java
index 60f1adb4..75ce62bf 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/EPRT.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/EPRT.java
@@ -36,12 +36,15 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* The EPRT command allows for the specification of an extended address for the
* data connection. The extended address MUST consist of the network protocol
as
* well as the network and transport addresses. The format of EPRT is:
*
- * EPRT<space><d><net-prt><d><net-addr><d><tcp-port><d>
+ * <p>
+ *
<code>EPRT<space><d><net-prt><d><net-addr><d><tcp-port><d></code>
+ * <p>
+ * where <d> is a delimiter, an ASCII char between 33 to 126. Character
'|' is recommanded.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/EPSV.java
b/core/src/main/java/org/apache/ftpserver/command/impl/EPSV.java
index fbcfc36c..9a8fa16f 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/EPSV.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/EPSV.java
@@ -33,7 +33,7 @@ import org.apache.ftpserver.impl.ServerDataConnectionFactory;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* The EPSV command requests that a server listen on a data port and wait for a
* connection. The EPSV command takes an optional argument. The response to
this
* command includes only the TCP port number of the listening connection. The
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/FEAT.java
b/core/src/main/java/org/apache/ftpserver/command/impl/FEAT.java
index c94ca647..25683cae 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/FEAT.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/FEAT.java
@@ -31,7 +31,7 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* The FEAT command (introduced in [RFC-2389]) allows servers with additional
* features to advertise these to a client by responding to the FEAT command.
If
* a server supports the FEAT command then it MUST advertise supported AUTH,
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/HELP.java
b/core/src/main/java/org/apache/ftpserver/command/impl/HELP.java
index 1524557a..b2dbbcf3 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/HELP.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/HELP.java
@@ -32,7 +32,9 @@ import org.apache.ftpserver.message.MessageResource;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>HELP [<SP> <string>] <CRLF></code><br>
+ * <p>
*
* This command shall cause the server to send helpful information regarding
its
* implementation status over the control connection to the user. The command
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/LANG.java
b/core/src/main/java/org/apache/ftpserver/command/impl/LANG.java
index f593fec9..08e1105f 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/LANG.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/LANG.java
@@ -33,7 +33,7 @@ import org.apache.ftpserver.message.MessageResource;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* A new command "LANG" is added to the FTP command set to allow server-FTP
* process to determine in which language to present server greetings and the
* textual part of command responses.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/LIST.java
b/core/src/main/java/org/apache/ftpserver/command/impl/LIST.java
index 865b032e..52432002 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/LIST.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/LIST.java
@@ -46,7 +46,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>LIST [<SP> <pathname>] <CRLF></code><br>
+ * <p>
*
* This command causes a list to be sent from the server to the passive DTP. If
* the pathname specifies a directory or other group of files, the server
should
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/MD5.java
b/core/src/main/java/org/apache/ftpserver/command/impl/MD5.java
index e775e5ad..c71871ae 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/MD5.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/MD5.java
@@ -39,8 +39,10 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>MD5 <SP> <pathname> <CRLF></code><br>
* <code>MMD5 <SP> <pathnames> <CRLF></code><br>
+ * <p>
*
* Returns the MD5 value for a file or multiple files according to
* draft-twine-ftpmd5-00.txt.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/MDTM.java
b/core/src/main/java/org/apache/ftpserver/command/impl/MDTM.java
index 2697f05f..d37f2e2c 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/MDTM.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/MDTM.java
@@ -36,7 +36,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>MDTM <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* Returns the date and time of when a file was modified.
*
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/MKD.java
b/core/src/main/java/org/apache/ftpserver/command/impl/MKD.java
index f4763656..2bf5eaa4 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/MKD.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/MKD.java
@@ -36,7 +36,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>MKD <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command causes the directory specified in the pathname to be created as
* a directory (if the pathname is absolute) or as a subdirectory of the
current
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/MLSD.java
b/core/src/main/java/org/apache/ftpserver/command/impl/MLSD.java
index d49b50ef..97513ff7 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/MLSD.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/MLSD.java
@@ -45,7 +45,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>MLSD [<SP> <pathname>] <CRLF></code><br>
+ * <p>
*
* This command causes a list to be sent from the server to the passive DTP.
The
* pathname must specify a directory and the server should transfer a list of
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/MLST.java
b/core/src/main/java/org/apache/ftpserver/command/impl/MLST.java
index ce1500a0..4b95f47b 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/MLST.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/MLST.java
@@ -39,7 +39,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>MLST <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* Returns info on the file over the control connection.
*
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/MODE.java
b/core/src/main/java/org/apache/ftpserver/command/impl/MODE.java
index af176dde..2a3e21df 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/MODE.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/MODE.java
@@ -31,7 +31,9 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
- * <code>MODE <SP> <mode-code> <CRLF></code><br>
+ * <p>
+ * <code>MODE <SP> <mode-code> <CRLF></code><br>
+ * <p>
*
* The argument is a single Telnet character code specifying the data transfer
* modes described in the Section on Transmission Modes.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/NLST.java
b/core/src/main/java/org/apache/ftpserver/command/impl/NLST.java
index d06593b2..6d41e7a3 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/NLST.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/NLST.java
@@ -46,7 +46,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>NLST [<SP> <pathname>] <CRLF></code><br>
+ * <p>
*
* This command causes a directory listing to be sent from server to user site.
* The pathname should specify a directory or other system-specific file group
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/NOOP.java
b/core/src/main/java/org/apache/ftpserver/command/impl/NOOP.java
index e44c1d10..8b8251cb 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/NOOP.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/NOOP.java
@@ -32,7 +32,9 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>NOOP <CRLF></code><br>
+ * <p>
*
* This command does not affect any parameters or previously entered commands.
* It specifies no action other than that the server send an OK reply.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/OPTS.java
b/core/src/main/java/org/apache/ftpserver/command/impl/OPTS.java
index e8240d66..a778aab9 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/OPTS.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/OPTS.java
@@ -36,7 +36,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
- * <code>OPTS<SP> <command> <SP> <option> <CRLF></code><br>
+ * <p>
+ * <code>OPTS <SP> <command> <SP> <option>
<CRLF></code><br>
+ * <p>
*
* This command shall cause the server use optional features for the command
* specified.
diff --git
a/core/src/main/java/org/apache/ftpserver/command/impl/OPTS_MLST.java
b/core/src/main/java/org/apache/ftpserver/command/impl/OPTS_MLST.java
index 95d59fe9..bc6147be 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/OPTS_MLST.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/OPTS_MLST.java
@@ -35,6 +35,7 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* Client-Server listing negotation. Instruct the server what listing types to
* include in machine directory/file listings.
*
diff --git
a/core/src/main/java/org/apache/ftpserver/command/impl/OPTS_UTF8.java
b/core/src/main/java/org/apache/ftpserver/command/impl/OPTS_UTF8.java
index 889d7ac1..a800cc6a 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/OPTS_UTF8.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/OPTS_UTF8.java
@@ -32,6 +32,7 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* Client-Server encoding negotiation. Force server from default encoding to
* UTF-8 and back. Note that the servers default encoding is UTF-8. So this
* command has no effect.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/PASS.java
b/core/src/main/java/org/apache/ftpserver/command/impl/PASS.java
index c8395a8b..48dd1e8a 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/PASS.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/PASS.java
@@ -45,7 +45,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
- * <code>PASS <SP> <password> <CRLF></code><br>
+ * <p>
+ * <code>PASS <SP> <password> <CRLF></code><br>
+ * <p>
*
* The argument field is a Telnet string specifying the user's password. This
* command must be immediately preceded by the user name command.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/PASV.java
b/core/src/main/java/org/apache/ftpserver/command/impl/PASV.java
index 2baffa6d..5bf8c7cc 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/PASV.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/PASV.java
@@ -39,27 +39,29 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>PASV <CRLF></code><br>
+ * <p>
*
* This command requests the server-DTP to "listen" on a data port (which is
not
* its default data port) and to wait for a connection rather than initiate one
* upon receipt of a transfer command. The response to this command includes
the
* host and port address this server is listening on.
- *
+ * <p>
* FTPServer allows the user to configure an "external address" at the listener
* level which will be the one reported by PASV response. This might solve
some of
* the issues with NATed addresses ( the reported IP is internal and not
accesible by the
* client) but not all of them - for example, if the FTPServer host has a
dynamic IP
* address. The solution for all these cases would be switching to the EPSV
command,
* which doesn't report any IP address back.
- *
+ * <p>
* In the case that EPSV command isn't available to the client, FTPServer
integrators
* can implement their own getPassiveExternalAddress to modify how the
External IP
* is resolved. One common approach would be retrieving this address from a
webpage
* which prints out the visitor's IP address. Another approach could be
returning the
* external IP address from the USER configuration(as when a single server is
mapped
* into different addresses).
- *
+ * <p>
* Please note that PASV command is an internal classes and thus shouldn't be
extended.
* Integrators may decide to extend it at their own risk, but they should be
aware that
* the 'internal API' can be changed at any moment. Besides, in some
environments
@@ -67,7 +69,6 @@ import org.slf4j.LoggerFactory;
* Still, the getPassiveExternalAddress method is provided for convenience so
the
* code to overwrite when reimplementing PASV command can be easily located.
*
- *
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
public class PASV extends AbstractCommand {
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/PBSZ.java
b/core/src/main/java/org/apache/ftpserver/command/impl/PBSZ.java
index 11a213b8..aaef2a42 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/PBSZ.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/PBSZ.java
@@ -31,7 +31,7 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* Protection buffer size.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/PORT.java
b/core/src/main/java/org/apache/ftpserver/command/impl/PORT.java
index fb05c1be..fd216f9c 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/PORT.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/PORT.java
@@ -40,7 +40,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
- * <code>PORT <SP> <host-port> <CRLF></code><br>
+ * <p>
+ * <code>PORT <SP> <host-port> <CRLF></code><br>
+ * <p>
*
* The argument is a HOST-PORT specification for the data port to be used in
* data connection. There are defaults for both the user and server data ports,
@@ -51,9 +53,11 @@ import org.slf4j.LoggerFactory;
* decimal number (in character string representation). The fields are
separated
* by commas. A port command would be:
*
+ * <pre>
* PORT h1,h2,h3,h4,p1,p2
+ * </pre>
*
- * where h1 is the high order 8 bits of the internet host address.
+ * where <code>h1</code> is the high order 8 bits of the internet host address.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/PROT.java
b/core/src/main/java/org/apache/ftpserver/command/impl/PROT.java
index eaf09a0c..b340b726 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/PROT.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/PROT.java
@@ -34,7 +34,7 @@ import org.apache.ftpserver.ssl.SslConfiguration;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* Data channel protection level.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/PWD.java
b/core/src/main/java/org/apache/ftpserver/command/impl/PWD.java
index 460ee9c8..612d7819 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/PWD.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/PWD.java
@@ -33,7 +33,9 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>PWD <CRLF></code><br>
+ * <p>
*
* This command causes the name of the current working directory to be returned
* in the reply.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/QUIT.java
b/core/src/main/java/org/apache/ftpserver/command/impl/QUIT.java
index 48d7c7a8..10e52d8e 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/QUIT.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/QUIT.java
@@ -33,7 +33,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>QUIT <CRLF></code><br>
+ * <p>
*
* This command terminates a USER and if file transfer is not in progress, the
* server closes the control connection.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/REIN.java
b/core/src/main/java/org/apache/ftpserver/command/impl/REIN.java
index 1762c03c..9d8548a8 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/REIN.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/REIN.java
@@ -31,7 +31,9 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>REIN <CRLF></code><br>
+ * <p>
*
* This command flushes a USER, without affecting transfers in progress. The
* server state should otherwise be as when the user first connects.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/REST.java
b/core/src/main/java/org/apache/ftpserver/command/impl/REST.java
index fd458490..6dfeb583 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/REST.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/REST.java
@@ -33,7 +33,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
- * <code>REST <SP> <marker> <CRLF></code><br>
+ * <p>
+ * <code>REST <SP> <marker> <CRLF></code><br>
+ * <p>
*
* The argument field represents the server marker at which file transfer is to
* be restarted. This command does not cause file transfer but skips over the
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/RETR.java
b/core/src/main/java/org/apache/ftpserver/command/impl/RETR.java
index eec00677..21067d01 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/RETR.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/RETR.java
@@ -47,7 +47,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>RETR <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command causes the server-DTP to transfer a copy of the file, specified
* in the pathname, to the server- or user-DTP at the other end of the data
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/RMD.java
b/core/src/main/java/org/apache/ftpserver/command/impl/RMD.java
index 10e2299e..df156f6e 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/RMD.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/RMD.java
@@ -36,7 +36,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>RMD <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command causes the directory specified in the pathname to be removed as
* a directory (if the pathname is absolute) or as a subdirectory of the
current
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/RNFR.java
b/core/src/main/java/org/apache/ftpserver/command/impl/RNFR.java
index 4c6c63ae..9790f9a6 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/RNFR.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/RNFR.java
@@ -35,7 +35,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>RNFR <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command specifies the old pathname of the file which is to be renamed.
* This command must be immediately followed by a "rename to" command
specifying
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/RNTO.java
b/core/src/main/java/org/apache/ftpserver/command/impl/RNTO.java
index 193ed245..491a30aa 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/RNTO.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/RNTO.java
@@ -35,7 +35,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>RNTO <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command specifies the new pathname of the file specified in the
* immediately preceding "rename from" command. Together the two commands cause
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/SITE.java
b/core/src/main/java/org/apache/ftpserver/command/impl/SITE.java
index 6ae764bc..195c5e8e 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/SITE.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/SITE.java
@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* Handle SITE command.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git
a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_DESCUSER.java
b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_DESCUSER.java
index 077728fd..13e4448a 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_DESCUSER.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_DESCUSER.java
@@ -38,7 +38,7 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* This SITE command returns the specified user information.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git
a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_HELP.java
b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_HELP.java
index 31cf54f6..1f761eba 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_HELP.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_HELP.java
@@ -31,7 +31,7 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* Show SITE help message.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git
a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_STAT.java
b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_STAT.java
index 755968a8..c438dd52 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_STAT.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_STAT.java
@@ -35,7 +35,7 @@ import org.apache.ftpserver.util.DateUtils;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* Show all statistics information.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_WHO.java
b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_WHO.java
index eb1b7749..a1e9da7e 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_WHO.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_WHO.java
@@ -40,7 +40,7 @@ import org.apache.mina.core.session.IoSession;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* Sends the list of all the connected users.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git
a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_ZONE.java
b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_ZONE.java
index 76daa6aa..83fd91b7 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/SITE_ZONE.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/SITE_ZONE.java
@@ -33,7 +33,7 @@ import org.apache.ftpserver.impl.FtpServerContext;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* Displays the FTP server timezone in RFC 822 format.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/SIZE.java
b/core/src/main/java/org/apache/ftpserver/command/impl/SIZE.java
index 205e9e99..afb70e71 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/SIZE.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/SIZE.java
@@ -34,8 +34,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* <code>SIZE <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* Returns the size of the file in bytes.
*
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/STAT.java
b/core/src/main/java/org/apache/ftpserver/command/impl/STAT.java
index f8544d55..27015fe7 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/STAT.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/STAT.java
@@ -39,7 +39,9 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>STAT [<SP> <pathname>] <CRLF></code><br>
+ * <p>
*
* This command shall cause a status response to be sent over the control
* connection in the form of a reply.
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/STOR.java
b/core/src/main/java/org/apache/ftpserver/command/impl/STOR.java
index 9ff620e9..abf3cc6a 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/STOR.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/STOR.java
@@ -45,7 +45,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>STOR <SP> <pathname> <CRLF></code><br>
+ * <p>
*
* This command causes the server-DTP to accept the data transferred via the
* data connection and to store the data as a file at the server site. If the
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/STOU.java
b/core/src/main/java/org/apache/ftpserver/command/impl/STOU.java
index 98ca5908..6ae9ecc9 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/STOU.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/STOU.java
@@ -45,7 +45,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>STOU <CRLF></code><br>
+ * <p>
*
* This command behaves like STOR except that the resultant file is to be
* created in the current directory under a name unique to that directory. The
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/STRU.java
b/core/src/main/java/org/apache/ftpserver/command/impl/STRU.java
index 620b53a2..4d231b82 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/STRU.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/STRU.java
@@ -34,7 +34,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>STRU <SP> <structure-code> <CRLF></code><br>
+ * <p>
*
* The argument is a single Telnet character code specifying file structure.
*
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/SYST.java
b/core/src/main/java/org/apache/ftpserver/command/impl/SYST.java
index 988de08a..3b80e770 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/SYST.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/SYST.java
@@ -31,7 +31,9 @@ import org.apache.ftpserver.impl.LocalizedFtpReply;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>SYST <CRLF></code><br>
+ * <p>
*
* This command is used to find out the type of operating system at the server.
*
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/TYPE.java
b/core/src/main/java/org/apache/ftpserver/command/impl/TYPE.java
index f5b936d5..214a1551 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/TYPE.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/TYPE.java
@@ -36,6 +36,7 @@ import org.slf4j.LoggerFactory;
*
* <code>TYPE <SP> <type-code> <CRLF></code><br>
*
+ * <p>
* The argument specifies the representation type.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git a/core/src/main/java/org/apache/ftpserver/command/impl/USER.java
b/core/src/main/java/org/apache/ftpserver/command/impl/USER.java
index 99239c01..6fdaa491 100644
--- a/core/src/main/java/org/apache/ftpserver/command/impl/USER.java
+++ b/core/src/main/java/org/apache/ftpserver/command/impl/USER.java
@@ -40,7 +40,9 @@ import org.slf4j.LoggerFactory;
/**
* <strong>Internal class, do not use directly.</strong>
*
+ * <p>
* <code>USER <SP> <username> <CRLF></code><br>
+ * <p>
*
* The argument field is a Telnet string identifying the user. The user
* identification is that which is required by the server for access to its
file
diff --git
a/core/src/main/java/org/apache/ftpserver/ftpletcontainer/FtpletContainer.java
b/core/src/main/java/org/apache/ftpserver/ftpletcontainer/FtpletContainer.java
index ebd3df8b..a21852ee 100644
---
a/core/src/main/java/org/apache/ftpserver/ftpletcontainer/FtpletContainer.java
+++
b/core/src/main/java/org/apache/ftpserver/ftpletcontainer/FtpletContainer.java
@@ -33,11 +33,9 @@ import org.apache.ftpserver.ftplet.Ftplet;
public interface FtpletContainer extends Ftplet {
/**
- * Retrieve the {@link Ftplet} identified by the name (as provided in the
- * {@link #addFtplet(String, Ftplet)} method.
+ * Retrieve the {@link Ftplet} identified by the name
*
- * @param name
- * The name of the Ftplet to retrive
+ * @param name The name of the Ftplet to retrive
* @return The Ftplet if found, or null if the name is unknown to the
* container.
*/
diff --git
a/core/src/main/java/org/apache/ftpserver/impl/DefaultFtpServerContext.java
b/core/src/main/java/org/apache/ftpserver/impl/DefaultFtpServerContext.java
index 38326c6c..9708d262 100644
--- a/core/src/main/java/org/apache/ftpserver/impl/DefaultFtpServerContext.java
+++ b/core/src/main/java/org/apache/ftpserver/impl/DefaultFtpServerContext.java
@@ -105,7 +105,7 @@ public class DefaultFtpServerContext implements
FtpServerContext {
* Create default users:
* <ul>
* <li>Admin</li>
- * <li>Anonymous</ul>
+ * <li>Anonymous</li>
* </ul>
*/
public void createDefaultUsers() throws Exception {
diff --git
a/core/src/main/java/org/apache/ftpserver/impl/IODataConnectionFactory.java
b/core/src/main/java/org/apache/ftpserver/impl/IODataConnectionFactory.java
index 39501bb7..1d49276d 100644
--- a/core/src/main/java/org/apache/ftpserver/impl/IODataConnectionFactory.java
+++ b/core/src/main/java/org/apache/ftpserver/impl/IODataConnectionFactory.java
@@ -391,7 +391,6 @@ public class IODataConnectionFactory implements
ServerDataConnectionFactory {
}
/**
- * @see org.apache.ftpserver.DataConnectionFactory#isSecure()
* {@inheritDoc}
*/
public boolean isSecure() {
@@ -407,7 +406,6 @@ public class IODataConnectionFactory implements
ServerDataConnectionFactory {
}
/**
- * @see org.apache.ftpserver.DataConnectionFactory#isZipMode()
* {@inheritDoc}
*/
public boolean isZipMode() {
diff --git a/core/src/main/java/org/apache/ftpserver/listener/Listener.java
b/core/src/main/java/org/apache/ftpserver/listener/Listener.java
index 937bd0bc..f55ecf3a 100644
--- a/core/src/main/java/org/apache/ftpserver/listener/Listener.java
+++ b/core/src/main/java/org/apache/ftpserver/listener/Listener.java
@@ -42,10 +42,8 @@ public interface Listener {
* Start the listener, will initiate the listener waiting on the socket.
The
* method should not return until the listener has started accepting socket
* requests.
- * @param serverContext The current {@link FtpServerContext}
*
- * @throws Exception
- * On error during start up
+ * @param serverContext The current {@link FtpServerContext}
*/
void start(FtpServerContext serverContext);
@@ -59,7 +57,7 @@ public interface Listener {
/**
* Checks if the listener is currently started.
*
- * @return False if the listener is started
+ * @return <code>false</code> if the listener is started
*/
boolean isStopped();
@@ -79,7 +77,7 @@ public interface Listener {
/**
* Checks if the listener is currently suspended
*
- * @return True if the listener is suspended
+ * @return <code>true</code> if the listener is suspended
*/
boolean isSuspended();
@@ -133,6 +131,7 @@ public interface Listener {
/**
* Get the number of seconds during which no network activity
* is allowed before a session is closed due to inactivity.
+ *
* @return The idle time out
*/
int getIdleTimeout();
diff --git
a/core/src/main/java/org/apache/ftpserver/listener/nio/AbstractListener.java
b/core/src/main/java/org/apache/ftpserver/listener/nio/AbstractListener.java
index 44b8faeb..e271f6a3 100644
--- a/core/src/main/java/org/apache/ftpserver/listener/nio/AbstractListener.java
+++ b/core/src/main/java/org/apache/ftpserver/listener/nio/AbstractListener.java
@@ -157,7 +157,8 @@ public abstract class AbstractListener implements Listener {
/**
* Used internally to update the port after binding
- * @param port
+ *
+ * @param port The port to set
*/
protected void setPort(int port) {
this.port = port;
diff --git a/core/src/main/java/org/apache/ftpserver/main/CommandLine.java
b/core/src/main/java/org/apache/ftpserver/main/CommandLine.java
index c1acdb3f..96ac1be3 100644
--- a/core/src/main/java/org/apache/ftpserver/main/CommandLine.java
+++ b/core/src/main/java/org/apache/ftpserver/main/CommandLine.java
@@ -30,7 +30,6 @@ import
org.springframework.context.support.FileSystemXmlApplicationContext;
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
public class CommandLine {
-
/**
* The purpose of this class is to allow the final user to start the
* FtpServer application. Because of that it has only <code>static</code>
@@ -102,6 +101,10 @@ public class CommandLine {
/**
* Get the configuration object.
+ *
+ * @param args The invocation arguments
+ * @return An instance of FtpServer
+ * @throws Exception If we've got an error trying to get the configuration
*/
protected FtpServer getConfiguration(String[] args) throws Exception {
switch (args.length) {
diff --git
a/core/src/main/java/org/apache/ftpserver/ssl/impl/DefaultSslConfiguration.java
b/core/src/main/java/org/apache/ftpserver/ssl/impl/DefaultSslConfiguration.java
index e0a0cd3a..bae0fbf6 100644
---
a/core/src/main/java/org/apache/ftpserver/ssl/impl/DefaultSslConfiguration.java
+++
b/core/src/main/java/org/apache/ftpserver/ssl/impl/DefaultSslConfiguration.java
@@ -115,8 +115,6 @@ public class DefaultSslConfiguration implements
SslConfiguration {
}
/**
- * @see SslConfiguration#getSSLContext(String)
- *
* {@inheritDoc}
*/
public SSLContext getSSLContext(String enabledProtocol) throws
GeneralSecurityException {
@@ -124,8 +122,6 @@ public class DefaultSslConfiguration implements
SslConfiguration {
}
/**
- * @see SslConfiguration#getEnabledProtocol()
- *
* @deprecated Use {@link #getEnabledProtocol()}
*
* {@inheritDoc}
@@ -135,8 +131,6 @@ public class DefaultSslConfiguration implements
SslConfiguration {
}
/**
- * @see SslConfiguration#getEnabledProtocol()
- *
* {@inheritDoc}
*/
public String getEnabledProtocol() {
@@ -149,8 +143,6 @@ public class DefaultSslConfiguration implements
SslConfiguration {
}
/**
- * @see SslConfiguration#getEnabledProtocols()
- *
* {@inheritDoc}
*/
public String[] getEnabledProtocols() {
@@ -158,8 +150,6 @@ public class DefaultSslConfiguration implements
SslConfiguration {
}
/**
- * @see SslConfiguration#getClientAuth()
- *
* {@inheritDoc}
*/
public ClientAuth getClientAuth() {
@@ -167,8 +157,6 @@ public class DefaultSslConfiguration implements
SslConfiguration {
}
/**
- * @see SslConfiguration#getSSLContext()
- *
* {@inheritDoc}
*/
public SSLContext getSSLContext() throws GeneralSecurityException {
@@ -176,8 +164,6 @@ public class DefaultSslConfiguration implements
SslConfiguration {
}
/**
- * @see SslConfiguration#getEnabledCipherSuites()
- *
* {@inheritDoc}
*/
public String[] getEnabledCipherSuites() {
diff --git
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/AbstractUserManager.java
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/AbstractUserManager.java
index 2d504396..d209143f 100644
---
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/AbstractUserManager.java
+++
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/AbstractUserManager.java
@@ -26,7 +26,7 @@ import org.apache.ftpserver.usermanager.PasswordEncryptor;
/**
* <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
* Abstract common base type for {@link UserManager} implementations
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
diff --git
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/DbUserManager.java
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/DbUserManager.java
index 8f3ac947..908cec36 100644
---
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/DbUserManager.java
+++
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/DbUserManager.java
@@ -47,7 +47,7 @@ import org.slf4j.LoggerFactory;
* <strong>Internal class, do not use directly.</strong>
*
* This is another database based user manager class. It has been tested in
- * MySQL and Oracle 8i database. The schema file is
</code>res/ftp-db.sql</code>
+ * MySQL and Oracle 8i database. The schema file is <code>res/ftp-db.sql</code>
*
* All the user attributes are replaced during run-time. So we can use your
* database schema. Then you need to modify the SQLs in the configuration file.
diff --git
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/PropertiesUserManager.java
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/PropertiesUserManager.java
index c79910cd..0ab7013e 100644
---
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/PropertiesUserManager.java
+++
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/PropertiesUserManager.java
@@ -48,10 +48,11 @@ import org.slf4j.LoggerFactory;
* <strong>Internal class, do not use directly.</strong>
*
* <p>Properties file based <code>UserManager</code> implementation. We use
- * <code>user.properties</code> file to store user data.</p>
+ * <code>user.properties</code> file to store user data.
*
- * </p>The file will use the following properties for storing users:</p>
+ * <p>The file will use the following properties for storing users:
* <table>
+ * <caption>User data properties</caption>
* <tr>
* <th>Property</th>
* <th>Documentation</th>
@@ -98,7 +99,7 @@ import org.slf4j.LoggerFactory;
* </tr>
* </table>
*
- * <p>Example:</p>
+ * <p>Example:
* <pre>
* ftpserver.user.admin.homedirectory=/ftproot
* ftpserver.user.admin.userpassword=admin
diff --git a/core/src/main/java/org/apache/ftpserver/util/StringUtils.java
b/core/src/main/java/org/apache/ftpserver/util/StringUtils.java
index 88c38a7e..dc5083dc 100644
--- a/core/src/main/java/org/apache/ftpserver/util/StringUtils.java
+++ b/core/src/main/java/org/apache/ftpserver/util/StringUtils.java
@@ -165,9 +165,9 @@ public class StringUtils {
*
* @param source the HTML code to be processes
* @param bReplaceNl if true '\n' will be replaced by <br>
- * @param bReplaceTag if true '<' will be replaced by < and
- * '>' will be replaced by >
- * @param bReplaceQuote if true '\"' will be replaced by "
+ * @param bReplaceTag if true '<' will be replaced by &lt; and
+ * '>' will be replaced by &gt;
+ * @param bReplaceQuote if true '\"' will be replaced by &quot;
* @return The HTML formatted string
*/
public static final String formatHtml(String source, boolean bReplaceNl,
