Fixed javadoc errors

Author: elecharny

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;
 }

core/src/main/java/org/apache/ftpserver/command/impl/ABOR.java

@@ -31,7 +31,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>ABOR &lt;CRLF&gt;</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 @@
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>
  */
 public class ABOR extends AbstractCommand {
-
     /**
      * Execute command
      *

core/src/main/java/org/apache/ftpserver/command/impl/ACCT.java

@@ -31,15 +31,16 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>ACCT &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * Acknowledges the ACCT (account) command with a 202 reply. The command however
  * is irrelevant to any workings.
  *
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>
  */
 public class ACCT extends AbstractCommand {
-
     /**
      * Execute command.
      *

core/src/main/java/org/apache/ftpserver/command/impl/APPE.java

@@ -45,7 +45,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>APPE &lt;SP&gt; &lt;pathname&gt; &lt;CRLF&gt;</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

core/src/main/java/org/apache/ftpserver/command/impl/AUTH.java

@@ -41,7 +41,7 @@
 
 /**
  * <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>

core/src/main/java/org/apache/ftpserver/command/impl/CDUP.java

@@ -36,7 +36,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>CDUP &lt;CRLF&gt;</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

core/src/main/java/org/apache/ftpserver/command/impl/CWD.java

@@ -36,7 +36,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>CWD  &lt;SP&gt; &lt;pathname&gt; &lt;CRLF&gt;</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.

core/src/main/java/org/apache/ftpserver/command/impl/DELE.java

@@ -36,7 +36,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>DELE &lt;SP&gt; &lt;pathname&gt; &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * This command causes the file specified in the pathname to be deleted at the
  * server site.

core/src/main/java/org/apache/ftpserver/command/impl/EPRT.java

@@ -36,12 +36,15 @@
 
 /**
  * <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&lt;space&gt;&lt;d&gt;&lt;net-prt&gt;&lt;d&gt;&lt;net-addr&gt;&lt;d&gt;&lt;tcp-port&gt;&lt;d&gt;</code>
+ * <p>
+ * where &lt;d&gt; is a delimiter, an ASCII char between 33 to 126. Character '|' is recommanded.
  *
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>
  */

core/src/main/java/org/apache/ftpserver/command/impl/EPSV.java

@@ -33,7 +33,7 @@
 
 /**
  * <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

core/src/main/java/org/apache/ftpserver/command/impl/FEAT.java

@@ -31,7 +31,7 @@
 
 /**
  * <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,

core/src/main/java/org/apache/ftpserver/command/impl/HELP.java

@@ -32,7 +32,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>HELP [&lt;SP&gt; &lt;string&gt;] &lt;CRLF&gt;</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

core/src/main/java/org/apache/ftpserver/command/impl/LANG.java

@@ -33,7 +33,7 @@
 
 /**
  * <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.

core/src/main/java/org/apache/ftpserver/command/impl/LIST.java

@@ -46,7 +46,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>LIST [&lt;SP&gt; &lt;pathname&gt;] &lt;CRLF&gt;</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

core/src/main/java/org/apache/ftpserver/command/impl/MD5.java

@@ -39,8 +39,10 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>MD5 &lt;SP&gt; &lt;pathname&gt; &lt;CRLF&gt;</code><br>
  * <code>MMD5 &lt;SP&gt; &lt;pathnames&gt; &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * Returns the MD5 value for a file or multiple files according to
  * draft-twine-ftpmd5-00.txt.

core/src/main/java/org/apache/ftpserver/command/impl/MDTM.java

@@ -36,7 +36,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>MDTM &lt;SP&gt; &lt;pathname&gt; &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * Returns the date and time of when a file was modified.
  *

core/src/main/java/org/apache/ftpserver/command/impl/MKD.java

@@ -36,7 +36,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>MKD  &lt;SP&gt; &lt;pathname&gt; &lt;CRLF&gt;</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

core/src/main/java/org/apache/ftpserver/command/impl/MLSD.java

@@ -45,7 +45,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>MLSD [&lt;SP&gt; &lt;pathname&gt;] &lt;CRLF&gt;</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

core/src/main/java/org/apache/ftpserver/command/impl/MLST.java

@@ -39,7 +39,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>MLST &lt;SP&gt; &lt;pathname&gt; &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * Returns info on the file over the control connection.
  *

core/src/main/java/org/apache/ftpserver/command/impl/MODE.java

@@ -31,7 +31,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
- * <code>MODE &lt;SP&gt; <mode-code> &lt;CRLF&gt;</code><br>
+ * <p>
+ * <code>MODE &lt;SP&gt; &lt;mode-code&gt; &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * The argument is a single Telnet character code specifying the data transfer
  * modes described in the Section on Transmission Modes.

core/src/main/java/org/apache/ftpserver/command/impl/NLST.java

@@ -46,7 +46,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>NLST [&lt;SP&gt; &lt;pathname&gt;] &lt;CRLF&gt;</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

core/src/main/java/org/apache/ftpserver/command/impl/NOOP.java

@@ -32,7 +32,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>NOOP &lt;CRLF&gt;</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.

core/src/main/java/org/apache/ftpserver/command/impl/OPTS.java

@@ -36,7 +36,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
- * <code>OPTS&lt;SP&gt; <command> &lt;SP&gt; <option> &lt;CRLF&gt;</code><br>
+ * <p>
+ * <code>OPTS &lt;SP&gt; &lt;command&gt; &lt;SP&gt; &lt;option&gt; &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * This command shall cause the server use optional features for the command
  * specified.

core/src/main/java/org/apache/ftpserver/command/impl/OPTS_MLST.java

@@ -35,6 +35,7 @@
 /**
  * <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.
  *

core/src/main/java/org/apache/ftpserver/command/impl/OPTS_UTF8.java

@@ -32,6 +32,7 @@
 /**
  * <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.

core/src/main/java/org/apache/ftpserver/command/impl/PASS.java

@@ -45,7 +45,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
- * <code>PASS &lt;SP&gt; <password> &lt;CRLF&gt;</code><br>
+ * <p>
+ * <code>PASS &lt;SP&gt; &lt;password&gt; &lt;CRLF&gt;</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.

core/src/main/java/org/apache/ftpserver/command/impl/PASV.java

@@ -39,35 +39,36 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>PASV &lt;CRLF&gt;</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
  * (OSGI) internal classes are not accesible and thus overriding won't work.
  * 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 {

core/src/main/java/org/apache/ftpserver/command/impl/PBSZ.java

@@ -31,7 +31,7 @@
 
 /**
  * <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
  * Protection buffer size.
  *
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>

core/src/main/java/org/apache/ftpserver/command/impl/PORT.java

@@ -40,7 +40,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
- * <code>PORT &lt;SP&gt; <host-port> &lt;CRLF&gt;</code><br>
+ * <p>
+ * <code>PORT &lt;SP&gt; &lt;host-port&gt; &lt;CRLF&gt;</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 @@
  * 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>
  */

core/src/main/java/org/apache/ftpserver/command/impl/PROT.java

@@ -34,7 +34,7 @@
 
 /**
  * <strong>Internal class, do not use directly.</strong>
- *
+ * <p>
  * Data channel protection level.
  *
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>

core/src/main/java/org/apache/ftpserver/command/impl/PWD.java

@@ -33,7 +33,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>PWD  &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * This command causes the name of the current working directory to be returned
  * in the reply.

core/src/main/java/org/apache/ftpserver/command/impl/QUIT.java

@@ -33,7 +33,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>QUIT &lt;CRLF&gt;</code><br>
+ * <p>
  *
  * This command terminates a USER and if file transfer is not in progress, the
  * server closes the control connection.

core/src/main/java/org/apache/ftpserver/command/impl/REIN.java

@@ -31,7 +31,9 @@
 /**
  * <strong>Internal class, do not use directly.</strong>
  *
+ * <p>
  * <code>REIN &lt;CRLF&gt;</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.