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-net.git
The following commit(s) were added to refs/heads/master by this push: new 2f9c1d65 Javadoc 2f9c1d65 is described below commit 2f9c1d650d5f4e641c7f1e34f374f4cb0f50d982 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Sat Feb 24 14:04:07 2024 -0500 Javadoc Remove extra whitespace in code tags --- .../java/org/apache/commons/net/SocketClient.java | 2 +- .../org/apache/commons/net/bsd/RCommandClient.java | 10 ++--- .../org/apache/commons/net/bsd/RExecClient.java | 8 ++-- .../org/apache/commons/net/bsd/RLoginClient.java | 2 +- .../commons/net/chargen/CharGenTCPClient.java | 2 +- .../commons/net/daytime/DaytimeTCPClient.java | 4 +- .../commons/net/discard/DiscardTCPClient.java | 2 +- .../org/apache/commons/net/echo/EchoTCPClient.java | 2 +- .../org/apache/commons/net/echo/EchoUDPClient.java | 4 +- .../apache/commons/net/finger/FingerClient.java | 4 +- src/main/java/org/apache/commons/net/ftp/FTP.java | 2 +- .../apache/commons/net/ftp/FTPClientConfig.java | 2 +- .../apache/commons/net/ftp/FTPFileEntryParser.java | 4 +- .../ftp/parser/EnterpriseUnixFTPEntryParser.java | 4 +- .../commons/net/ftp/parser/MVSFTPEntryParser.java | 4 +- .../net/ftp/parser/MacOsPeterFTPEntryParser.java | 4 +- .../commons/net/ftp/parser/NTFTPEntryParser.java | 4 +- .../net/ftp/parser/NetwareFTPEntryParser.java | 4 +- .../commons/net/ftp/parser/OS2FTPEntryParser.java | 4 +- .../commons/net/ftp/parser/UnixFTPEntryParser.java | 4 +- .../commons/net/ftp/parser/VMSFTPEntryParser.java | 4 +- .../java/org/apache/commons/net/imap/IMAP.java | 2 +- src/main/java/org/apache/commons/net/io/Util.java | 4 +- .../java/org/apache/commons/net/nntp/NNTP.java | 6 +-- .../org/apache/commons/net/nntp/NNTPClient.java | 50 +++++++++++----------- .../commons/net/nntp/NewGroupsOrNewsQuery.java | 6 +-- .../org/apache/commons/net/nntp/NewsgroupInfo.java | 2 +- .../apache/commons/net/nntp/SimpleNNTPHeader.java | 6 +-- .../java/org/apache/commons/net/pop3/POP3.java | 4 +- .../apache/commons/net/pop3/POP3MessageInfo.java | 16 +++---- .../java/org/apache/commons/net/smtp/SMTP.java | 6 +-- .../org/apache/commons/net/smtp/SMTPClient.java | 4 +- .../org/apache/commons/net/time/TimeTCPClient.java | 6 +-- .../org/apache/commons/net/time/TimeUDPClient.java | 4 +- .../org/apache/commons/net/whois/WhoisClient.java | 2 +- 35 files changed, 99 insertions(+), 99 deletions(-) diff --git a/src/main/java/org/apache/commons/net/SocketClient.java b/src/main/java/org/apache/commons/net/SocketClient.java index 9bff99f6..bfd32c05 100644 --- a/src/main/java/org/apache/commons/net/SocketClient.java +++ b/src/main/java/org/apache/commons/net/SocketClient.java @@ -149,7 +149,7 @@ public abstract class SocketClient { * This method sets the timeout on the just opened socket to the default timeout set by {@link #setDefaultTimeout setDefaultTimeout() }, sets _input_ and * _output_ to the socket's InputStream and OutputStream respectively, and sets _isConnected_ to true. * <p> - * Subclasses overriding this method should start by calling <code> super._connectAction_() </code> first to ensure the initialization of the aforementioned + * Subclasses overriding this method should start by calling <code>super._connectAction_()</code> first to ensure the initialization of the aforementioned * protected variables. * * @throws IOException (SocketException) if a problem occurs with the socket diff --git a/src/main/java/org/apache/commons/net/bsd/RCommandClient.java b/src/main/java/org/apache/commons/net/bsd/RCommandClient.java index 13b57203..f527c942 100644 --- a/src/main/java/org/apache/commons/net/bsd/RCommandClient.java +++ b/src/main/java/org/apache/commons/net/bsd/RCommandClient.java @@ -51,7 +51,7 @@ import org.apache.commons.net.io.SocketInputStream; * returned by {@link org.apache.commons.net.bsd.RExecClient#getInputStream getInputStream() } . However, it is possible to tell the rshd daemon to return the * standard error stream over a separate connection, readable from the input stream returned by {@link org.apache.commons.net.bsd.RExecClient#getErrorStream * getErrorStream() } . You can specify that a separate connection should be created for standard error by setting the boolean - * <code> separateErrorStream </code> parameter of {@link #rcommand rcommand() } to <code> true </code>. The standard input of the remote process can be written + * <code>separateErrorStream</code> parameter of {@link #rcommand rcommand() } to <code>true</code>. The standard input of the remote process can be written * to through the output stream returned by {@link org.apache.commons.net.bsd.RExecClient#getOutputStream getOutputStream() } . * </p> * @@ -76,7 +76,7 @@ public class RCommandClient extends RExecClient { public static final int MAX_CLIENT_PORT = 1023; /** - * The default RCommandClient constructor. Initializes the default port to <code> DEFAULT_PORT </code>. + * The default RCommandClient constructor. Initializes the default port to <code>DEFAULT_PORT</code>. */ public RCommandClient() { setDefaultPort(DEFAULT_PORT); @@ -133,7 +133,7 @@ public class RCommandClient extends RExecClient { /** * Opens a Socket connected to a remote host at the specified port and originating from the specified local address and port. The local port must lie - * between <code> MIN_CLIENT_PORT </code> and <code> MAX_CLIENT_PORT </code> or an IllegalArgumentException will be thrown. Before returning, + * between <code>MIN_CLIENT_PORT</code> and <code>MAX_CLIENT_PORT</code> or an IllegalArgumentException will be thrown. Before returning, * {@link org.apache.commons.net.SocketClient#_connectAction_ _connectAction_() } is called to perform connection initialization actions. * * @param host The remote host. @@ -191,7 +191,7 @@ public class RCommandClient extends RExecClient { /** * Opens a Socket connected to a remote host at the specified port and originating from the specified local address and port. The local port must lie - * between <code> MIN_CLIENT_PORT </code> and <code> MAX_CLIENT_PORT </code> or an IllegalArgumentException will be thrown. Before returning, + * between <code>MIN_CLIENT_PORT</code> and <code>MAX_CLIENT_PORT</code> or an IllegalArgumentException will be thrown. Before returning, * {@link org.apache.commons.net.SocketClient#_connectAction_ _connectAction_() } is called to perform connection initialization actions. * * @param hostname The name of the remote host. @@ -246,7 +246,7 @@ public class RCommandClient extends RExecClient { } /** - * Same as <code> rcommand(localUserName, remoteUserName, command, false); </code> + * Same as <code>rcommand(localUserName, remoteUserName, command, false);</code> * * @param localUser the local user * @param remoteUser the remote user diff --git a/src/main/java/org/apache/commons/net/bsd/RExecClient.java b/src/main/java/org/apache/commons/net/bsd/RExecClient.java index 2a2bbe6c..776d0741 100644 --- a/src/main/java/org/apache/commons/net/bsd/RExecClient.java +++ b/src/main/java/org/apache/commons/net/bsd/RExecClient.java @@ -41,7 +41,7 @@ import org.apache.commons.net.util.NetConstants; * By default, the standard output and standard error streams of the remote process are transmitted over the same connection, readable from the input stream * returned by {@link #getInputStream getInputStream()}. However, it is possible to tell the rexecd daemon to return the standard error stream over a separate * connection, readable from the input stream returned by {@link #getErrorStream getErrorStream()}. You can specify that a separate connection should be created - * for standard error by setting the boolean <code> separateErrorStream </code> parameter of {@link #rexec rexec()} to <code> true </code>. The standard input + * for standard error by setting the boolean <code>separateErrorStream</code> parameter of {@link #rexec rexec()} to <code>true</code>. The standard input * of the remote process can be written to through the output stream returned by {@link #getOutputStream getOutputSream()}. * * @see SocketClient @@ -64,12 +64,12 @@ public class RExecClient extends SocketClient { /** * If a separate error stream is requested, <code>_errorStream_</code> will point to an InputStream from which the standard error of the remote process can - * be read (after a call to rexec()). Otherwise, <code> _errorStream_ </code> will be null. + * be read (after a call to rexec()). Otherwise, <code>_errorStream_</code> will be null. */ protected InputStream _errorStream_; /** - * The default RExecClient constructor. Initializes the default port to <code> DEFAULT_PORT </code>. + * The default RExecClient constructor. Initializes the default port to <code>DEFAULT_PORT</code>. */ public RExecClient() { _errorStream_ = null; @@ -152,7 +152,7 @@ public class RExecClient extends SocketClient { } /** - * Same as <code> rexec(user, password, command, false); </code> + * Same as <code>rexec(user, password, command, false);</code> * * @param user the user name * @param password the password diff --git a/src/main/java/org/apache/commons/net/bsd/RLoginClient.java b/src/main/java/org/apache/commons/net/bsd/RLoginClient.java index d7f96971..69cc3be5 100644 --- a/src/main/java/org/apache/commons/net/bsd/RLoginClient.java +++ b/src/main/java/org/apache/commons/net/bsd/RLoginClient.java @@ -50,7 +50,7 @@ public class RLoginClient extends RCommandClient { public static final int DEFAULT_PORT = 513; /** - * The default RLoginClient constructor. Initializes the default port to <code> DEFAULT_PORT </code>. + * The default RLoginClient constructor. Initializes the default port to <code>DEFAULT_PORT</code>. */ public RLoginClient() { setDefaultPort(DEFAULT_PORT); diff --git a/src/main/java/org/apache/commons/net/chargen/CharGenTCPClient.java b/src/main/java/org/apache/commons/net/chargen/CharGenTCPClient.java index 96c00077..51129250 100644 --- a/src/main/java/org/apache/commons/net/chargen/CharGenTCPClient.java +++ b/src/main/java/org/apache/commons/net/chargen/CharGenTCPClient.java @@ -47,7 +47,7 @@ public final class CharGenTCPClient extends SocketClient { public static final int DEFAULT_PORT = 19; /** - * The default constructor for CharGenTCPClient. It merely sets the default port to <code> DEFAULT_PORT </code>. + * The default constructor for CharGenTCPClient. It merely sets the default port to <code>DEFAULT_PORT</code>. */ public CharGenTCPClient() { setDefaultPort(DEFAULT_PORT); diff --git a/src/main/java/org/apache/commons/net/daytime/DaytimeTCPClient.java b/src/main/java/org/apache/commons/net/daytime/DaytimeTCPClient.java index 5c51b0d0..d5043308 100644 --- a/src/main/java/org/apache/commons/net/daytime/DaytimeTCPClient.java +++ b/src/main/java/org/apache/commons/net/daytime/DaytimeTCPClient.java @@ -39,7 +39,7 @@ public final class DaytimeTCPClient extends SocketClient { private final char[] buffer = new char[64]; /** - * The default DaytimeTCPClient constructor. It merely sets the default port to <code> DEFAULT_PORT </code>. + * The default DaytimeTCPClient constructor. It merely sets the default port to <code>DEFAULT_PORT</code>. */ public DaytimeTCPClient() { setDefaultPort(DEFAULT_PORT); @@ -48,7 +48,7 @@ public final class DaytimeTCPClient extends SocketClient { /** * Retrieves the time string from the server and returns it. The server will have closed the connection at this point, so you should call * {@link org.apache.commons.net.SocketClient#disconnect disconnect } after calling this method. To retrieve another time, you must initiate another - * connection with {@link org.apache.commons.net.SocketClient#connect connect } before calling <code> getTime() </code> again. + * connection with {@link org.apache.commons.net.SocketClient#connect connect } before calling <code>getTime()</code> again. * * @return The time string retrieved from the server. * @throws IOException If an error occurs while fetching the time string. diff --git a/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java b/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java index 669d8e43..ccc9b75a 100644 --- a/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java +++ b/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java @@ -35,7 +35,7 @@ public class DiscardTCPClient extends SocketClient { public static final int DEFAULT_PORT = 9; /** - * The default DiscardTCPClient constructor. It merely sets the default port to <code> DEFAULT_PORT </code>. + * The default DiscardTCPClient constructor. It merely sets the default port to <code>DEFAULT_PORT</code>. */ public DiscardTCPClient() { setDefaultPort(DEFAULT_PORT); diff --git a/src/main/java/org/apache/commons/net/echo/EchoTCPClient.java b/src/main/java/org/apache/commons/net/echo/EchoTCPClient.java index 77d22ab0..173289cb 100644 --- a/src/main/java/org/apache/commons/net/echo/EchoTCPClient.java +++ b/src/main/java/org/apache/commons/net/echo/EchoTCPClient.java @@ -36,7 +36,7 @@ public final class EchoTCPClient extends DiscardTCPClient { public static final int DEFAULT_PORT = 7; /** - * The default EchoTCPClient constructor. It merely sets the default port to <code> DEFAULT_PORT </code>. + * The default EchoTCPClient constructor. It merely sets the default port to <code>DEFAULT_PORT</code>. */ public EchoTCPClient() { setDefaultPort(DEFAULT_PORT); diff --git a/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java b/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java index da642a4e..b305a11b 100644 --- a/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java +++ b/src/main/java/org/apache/commons/net/echo/EchoUDPClient.java @@ -40,7 +40,7 @@ public final class EchoUDPClient extends DiscardUDPClient { private final DatagramPacket receivePacket = new DatagramPacket(NetConstants.EMPTY_BTYE_ARRAY, 0); /** - * Same as <code> receive(data, data.length)</code> + * Same as <code>receive(data, data.length)</code> * * @param data the buffer to receive the input * @return the number of bytes @@ -67,7 +67,7 @@ public final class EchoUDPClient extends DiscardUDPClient { return receivePacket.getLength(); } - /** Same as <code> send(data, data.length, host) </code> */ + /** Same as <code>send(data, data.length, host)</code> */ @Override public void send(final byte[] data, final InetAddress host) throws IOException { send(data, data.length, host, DEFAULT_PORT); diff --git a/src/main/java/org/apache/commons/net/finger/FingerClient.java b/src/main/java/org/apache/commons/net/finger/FingerClient.java index 1fe4b0d6..0798c910 100644 --- a/src/main/java/org/apache/commons/net/finger/FingerClient.java +++ b/src/main/java/org/apache/commons/net/finger/FingerClient.java @@ -58,7 +58,7 @@ public class FingerClient extends SocketClient { private final transient char[] buffer = new char[1024]; /** - * The default FingerClient constructor. Initializes the default port to <code> DEFAULT_PORT </code>. + * The default FingerClient constructor. Initializes the default port to <code>DEFAULT_PORT</code>. */ public FingerClient() { setDefaultPort(DEFAULT_PORT); @@ -122,7 +122,7 @@ public class FingerClient extends SocketClient { /** * Fingers the connected host and returns the output as a String. You must first connect to a finger server before calling this method, and you should - * disconnect afterward. This is equivalent to calling <code> query(longOutput, "") </code>. + * disconnect afterward. This is equivalent to calling <code>query(longOutput, "")</code>. * * @param longOutput Set to true if long output is requested, false if not. * @return The result of the finger query. diff --git a/src/main/java/org/apache/commons/net/ftp/FTP.java b/src/main/java/org/apache/commons/net/ftp/FTP.java index 862cbbd4..227b10ab 100644 --- a/src/main/java/org/apache/commons/net/ftp/FTP.java +++ b/src/main/java/org/apache/commons/net/ftp/FTP.java @@ -653,7 +653,7 @@ public class FTP extends SocketClient { /** * Returns the integer value of the reply code of the last FTP reply. You will usually only use this method after you connect to the FTP server to check - * that the connection was successful since <code> connect </code> is of type void. + * that the connection was successful since <code>connect</code> is of type void. * * @return The integer value of the reply code of the last FTP reply. */ diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java b/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java index 4383af8e..eabd5a9e 100644 --- a/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java +++ b/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java @@ -546,7 +546,7 @@ public class FTPClientConfig { * </p> * <p> * If the code supplied is not supported here, <code>en_US</code> month names will be used. We are supporting here those language codes which, when a - * <code> java.util.Locale</code> is constructed using it, and a <code>java.text.SimpleDateFormat</code> is constructed using that Locale, the array + * <code>java.util.Locale</code> is constructed using it, and a <code>java.text.SimpleDateFormat</code> is constructed using that Locale, the array * returned by the SimpleDateFormat's <code>getShortMonths()</code> method consists solely of three 8-bit ASCII character strings. Additionally, languages * which do not meet this requirement are included if a common alternative set of short month names is known to be used. This means that users who can tell * us of additional such encodings may get them added to the list of supported languages by contacting the Apache Commons Net team. diff --git a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java index 0de9da1e..71ec2f6c 100644 --- a/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java @@ -66,8 +66,8 @@ import java.util.List; */ public interface FTPFileEntryParser { /** - * Parses a line of an FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the file listing - * line doesn't describe a file, <code> null </code> should be returned, otherwise a <code> FTPFile </code> instance representing the files in the directory + * Parses a line of an FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the file listing + * line doesn't describe a file, <code>null</code> should be returned, otherwise a <code>FTPFile</code> instance representing the files in the directory * is returned. * * @param listEntry A line of text from the file listing diff --git a/src/main/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java index 0310d30c..54a4fe1d 100644 --- a/src/main/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/parser/EnterpriseUnixFTPEntryParser.java @@ -69,8 +69,8 @@ public class EnterpriseUnixFTPEntryParser extends RegexFTPFileEntryParserImpl { } /** - * Parses a line of a unix FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the file - * listing line doesn't describe a file, <code> null </code> is returned, otherwise a <code> FTPFile </code> instance representing the files in the + * Parses a line of a unix FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the file + * listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the * directory is returned. * * @param entry A line of text from the file listing diff --git a/src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java index 57beb8fa..533a2476 100644 --- a/src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java @@ -285,8 +285,8 @@ public class MVSFTPEntryParser extends ConfigurableFTPFileEntryParserImpl { } /** - * Parses a line of a z/OS - MVS FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the - * file listing line doesn't describe a file, then <code> null </code> is returned. Otherwise, a <code> FTPFile </code> instance representing the file is + * Parses a line of a z/OS - MVS FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the + * file listing line doesn't describe a file, then <code>null</code> is returned. Otherwise, a <code>FTPFile</code> instance representing the file is * returned. * * @param entry A line of text from the file listing diff --git a/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java index 7b72a4aa..8930389b 100644 --- a/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/parser/MacOsPeterFTPEntryParser.java @@ -92,8 +92,8 @@ public class MacOsPeterFTPEntryParser extends ConfigurableFTPFileEntryParserImpl } /** - * Parses a line of a unix (standard) FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the - * file listing line doesn't describe a file, <code> null </code> is returned, otherwise a <code> FTPFile </code> instance representing the files in the + * Parses a line of a unix (standard) FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the + * file listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the * directory is returned. * * @param entry A line of text from the file listing diff --git a/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java index 2c9eb532..f6fd46dc 100644 --- a/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java @@ -82,8 +82,8 @@ public class NTFTPEntryParser extends ConfigurableFTPFileEntryParserImpl { } /** - * Parses a line of an NT FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the file - * listing line doesn't describe a file, <code> null </code> is returned, otherwise a <code> FTPFile </code> instance representing the files in the + * Parses a line of an NT FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the file + * listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the * directory is returned. * * @param entry A line of text from the file listing diff --git a/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java index 9f6b53d3..4b5a8822 100644 --- a/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java @@ -85,8 +85,8 @@ public class NetwareFTPEntryParser extends ConfigurableFTPFileEntryParserImpl { } /** - * Parses a line of an NetwareFTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the file - * listing line doesn't describe a file, <code> null </code> is returned, otherwise a <code> FTPFile </code> instance representing the files in the + * Parses a line of an NetwareFTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the file + * listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the * directory is returned. * <p> * Netware file permissions are in the following format: RWCEAFMS, and are explained as follows: diff --git a/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java index e77cc5b9..4fec1423 100644 --- a/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java @@ -72,8 +72,8 @@ public class OS2FTPEntryParser extends ConfigurableFTPFileEntryParserImpl } /** - * Parses a line of an OS2 FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the file - * listing line doesn't describe a file, <code> null </code> is returned, otherwise a <code> FTPFile </code> instance representing the files in the + * Parses a line of an OS2 FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the file + * listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the * directory is returned. * * @param entry A line of text from the file listing diff --git a/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java index fa22607c..40539b72 100644 --- a/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java @@ -158,8 +158,8 @@ public class UnixFTPEntryParser extends ConfigurableFTPFileEntryParserImpl { } /** - * Parses a line of a unix (standard) FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the - * file listing line doesn't describe a file, <code> null </code> is returned, otherwise a <code> FTPFile </code> instance representing the files in the + * Parses a line of a unix (standard) FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the + * file listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the * directory is returned. * * @param entry A line of text from the file listing diff --git a/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java index c04b9529..921dfce5 100644 --- a/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java +++ b/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java @@ -107,8 +107,8 @@ public class VMSFTPEntryParser extends ConfigurableFTPFileEntryParserImpl { } /** - * Parses a line of a VMS FTP server file listing and converts it into a usable format in the form of an <code> FTPFile </code> instance. If the file - * listing line doesn't describe a file, <code> null </code> is returned, otherwise a <code> FTPFile </code> instance representing the files in the + * Parses a line of a VMS FTP server file listing and converts it into a usable format in the form of an <code>FTPFile</code> instance. If the file + * listing line doesn't describe a file, <code>null</code> is returned, otherwise a <code>FTPFile</code> instance representing the files in the * directory is returned. * * @param entry A line of text from the file listing diff --git a/src/main/java/org/apache/commons/net/imap/IMAP.java b/src/main/java/org/apache/commons/net/imap/IMAP.java index ca3c1b34..2f8e33aa 100644 --- a/src/main/java/org/apache/commons/net/imap/IMAP.java +++ b/src/main/java/org/apache/commons/net/imap/IMAP.java @@ -157,7 +157,7 @@ public class IMAP extends SocketClient { } /** - * Disconnects the client from the server, and sets the state to <code> DISCONNECTED_STATE </code>. The reply text information from the last issued command + * Disconnects the client from the server, and sets the state to <code>DISCONNECTED_STATE</code>. The reply text information from the last issued command * is voided to allow garbage collection of the memory used to store that information. * * @throws IOException If there is an error in disconnecting. diff --git a/src/main/java/org/apache/commons/net/io/Util.java b/src/main/java/org/apache/commons/net/io/Util.java index 86f57204..41b2a40d 100644 --- a/src/main/java/org/apache/commons/net/io/Util.java +++ b/src/main/java/org/apache/commons/net/io/Util.java @@ -76,7 +76,7 @@ public final class Util { } /** - * Same as <code> copyReader(source, dest, DEFAULT_COPY_BUFFER_SIZE); </code> + * Same as <code>copyReader(source, dest, DEFAULT_COPY_BUFFER_SIZE);</code> * * @param source where to copy from * @param dest where to copy to @@ -164,7 +164,7 @@ public final class Util { } /** - * Same as <code> copyStream(source, dest, DEFAULT_COPY_BUFFER_SIZE); </code> + * Same as <code>copyStream(source, dest, DEFAULT_COPY_BUFFER_SIZE);</code> * * @param source where to copy from * @param dest where to copy to diff --git a/src/main/java/org/apache/commons/net/nntp/NNTP.java b/src/main/java/org/apache/commons/net/nntp/NNTP.java index 0fb58ac0..454bd532 100644 --- a/src/main/java/org/apache/commons/net/nntp/NNTP.java +++ b/src/main/java/org/apache/commons/net/nntp/NNTP.java @@ -40,8 +40,8 @@ import org.apache.commons.net.io.CRLFLineReader; * if the server is being shutdown by the operator or some other reason. The NNTP class will detect a premature NNTP server connection closing when it receives * a {@link org.apache.commons.net.nntp.NNTPReply#SERVICE_DISCONTINUED NNTPReply.SERVICE_DISCONTINUED } response to a command. When that occurs, the NNTP class * method encountering that reply will throw an {@link org.apache.commons.net.nntp.NNTPConnectionClosedException} . <code>NNTPConectionClosedException</code> is - * a subclass of <code> IOException </code> and therefore need not be caught separately, but if you are going to catch it separately, its catch block must - * appear before the more general <code> IOException </code> catch block. When you encounter an + * a subclass of <code>IOException</code> and therefore need not be caught separately, but if you are going to catch it separately, its catch block must + * appear before the more general <code>IOException</code> catch block. When you encounter an * {@link org.apache.commons.net.nntp.NNTPConnectionClosedException} , you must disconnect the connection with {@link #disconnect disconnect() } to properly * clean up the system resources used by NNTP. Before disconnecting, you may check the last reply code and text with {@link #getReplyCode getReplyCode } and * {@link #getReplyString getReplyString }. @@ -313,7 +313,7 @@ public class NNTP extends SocketClient { /** * Returns the integer value of the reply code of the last NNTP reply. You will usually only use this method after you connect to the NNTP server to check - * that the connection was successful since <code> connect </code> is of type void. + * that the connection was successful since <code>connect</code> is of type void. * * @return The integer value of the reply code of the last NNTP reply. */ diff --git a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java index c42014f0..31dada82 100644 --- a/src/main/java/org/apache/commons/net/nntp/NNTPClient.java +++ b/src/main/java/org/apache/commons/net/nntp/NNTPClient.java @@ -41,8 +41,8 @@ import org.apache.commons.net.util.NetConstants; * if the server is being shutdown by the operator or some other reason. The NNTP class will detect a premature NNTP server connection closing when it receives * a {@link org.apache.commons.net.nntp.NNTPReply#SERVICE_DISCONTINUED NNTPReply.SERVICE_DISCONTINUED } response to a command. When that occurs, the NNTP class * method encountering that reply will throw an {@link org.apache.commons.net.nntp.NNTPConnectionClosedException} . <code>NNTPConectionClosedException</code> is - * a subclass of <code> IOException </code> and therefore need not be caught separately, but if you are going to catch it separately, its catch block must - * appear before the more general <code> IOException </code> catch block. When you encounter an + * a subclass of <code>IOException</code> and therefore need not be caught separately, but if you are going to catch it separately, its catch block must + * appear before the more general <code>IOException</code> catch block. When you encounter an * {@link org.apache.commons.net.nntp.NNTPConnectionClosedException} , you must disconnect the connection with * {@link org.apache.commons.net.nntp.NNTP#disconnect disconnect() } to properly clean up the system resources used by NNTP. Before disconnecting, you may check * the last reply code and text with {@link org.apache.commons.net.nntp.NNTP#getReplyCode getReplyCode } and @@ -651,7 +651,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticle((String) null) </code> Note: the return can be cast to a {@link BufferedReader} + * Same as <code>retrieveArticle((String) null)</code> Note: the return can be cast to a {@link BufferedReader} * * @return A DotTerminatedMessageReader instance from which the article can be read. null if the article does not exist. * @throws IOException if an IO error occurs @@ -687,7 +687,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticle(articleNumber, null) </code> + * Same as <code>retrieveArticle(articleNumber, null)</code> * * @param articleNumber the article number to fetch * @return A DotTerminatedMessageReader instance from which the article can be read. null if the article does not exist. @@ -699,7 +699,7 @@ public class NNTPClient extends NNTP { /** * Retrieves an article from the currently selected newsgroup. The article is referenced by its article number. The article number and identifier contained - * in the server reply are returned through an ArticleInfo. The <code> articleId </code> field of the ArticleInfo cannot always be trusted because some NNTP + * in the server reply are returned through an ArticleInfo. The <code>articleId</code> field of the ArticleInfo cannot always be trusted because some NNTP * servers do not correctly follow the RFC 977 reply format. * <p> * A DotTerminatedMessageReader is returned from which the article can be read. If the article does not exist, null is returned. @@ -726,7 +726,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticle(articleId, (ArticleInfo) null) </code> Note: the return can be cast to a {@link BufferedReader} + * Same as <code>retrieveArticle(articleId, (ArticleInfo) null)</code> Note: the return can be cast to a {@link BufferedReader} * * @param articleId the article id to retrieve * @return A DotTerminatedMessageReader instance from which the article can be read. null if the article does not exist. @@ -738,7 +738,7 @@ public class NNTPClient extends NNTP { /** * Retrieves an article from the NNTP server. The article is referenced by its unique article identifier (including the enclosing < and >). The - * article number and identifier contained in the server reply are returned through an ArticleInfo. The <code> articleId </code> field of the ArticleInfo + * article number and identifier contained in the server reply are returned through an ArticleInfo. The <code>articleId</code> field of the ArticleInfo * cannot always be trusted because some NNTP servers do not correctly follow the RFC 977 reply format. * <p> * A DotTerminatedMessageReader is returned from which the article can be read. If the article does not exist, null is returned. @@ -781,7 +781,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticleBody(null) </code> Note: the return can be cast to a {@link BufferedReader} + * Same as <code>retrieveArticleBody(null)</code> Note: the return can be cast to a {@link BufferedReader} * * @return A DotTerminatedMessageReader instance from which the article body can be read. null if the article does not exist. * @throws IOException if an error occurs @@ -817,7 +817,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticleBody(articleNumber, null) </code> + * Same as <code>retrieveArticleBody(articleNumber, null)</code> * * @param articleNumber the article number * @return the reader @@ -829,7 +829,7 @@ public class NNTPClient extends NNTP { /** * Retrieves an article body from the currently selected newsgroup. The article is referenced by its article number. The article number and identifier - * contained in the server reply are returned through an ArticleInfo. The <code> articleId </code> field of the ArticleInfo cannot always be trusted because + * contained in the server reply are returned through an ArticleInfo. The <code>articleId</code> field of the ArticleInfo cannot always be trusted because * some NNTP servers do not correctly follow the RFC 977 reply format. * <p> * A DotTerminatedMessageReader is returned from which the article can be read. If the article does not exist, null is returned. @@ -856,7 +856,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticleBody(articleId, (ArticleInfo) null) </code> Note: the return can be cast to a {@link BufferedReader} + * Same as <code>retrieveArticleBody(articleId, (ArticleInfo) null)</code> Note: the return can be cast to a {@link BufferedReader} * * @param articleId the article id * @return A DotTerminatedMessageReader instance from which the article body can be read. null if the article does not exist. @@ -868,7 +868,7 @@ public class NNTPClient extends NNTP { /** * Retrieves an article body from the NNTP server. The article is referenced by its unique article identifier (including the enclosing < and >). The - * article number and identifier contained in the server reply are returned through an ArticleInfo. The <code> articleId </code> field of the ArticleInfo + * article number and identifier contained in the server reply are returned through an ArticleInfo. The <code>articleId</code> field of the ArticleInfo * cannot always be trusted because some NNTP servers do not correctly follow the RFC 977 reply format. * <p> * A DotTerminatedMessageReader is returned from which the article can be read. If the article does not exist, null is returned. @@ -912,7 +912,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticleHeader((String) null) </code> Note: the return can be cast to a {@link BufferedReader} + * Same as <code>retrieveArticleHeader((String) null)</code> Note: the return can be cast to a {@link BufferedReader} * * @return the reader * @throws IOException if an error occurs @@ -948,7 +948,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticleHeader(articleNumber, null) </code> + * Same as <code>retrieveArticleHeader(articleNumber, null)</code> * * @param articleNumber the article number * @return the reader @@ -960,7 +960,7 @@ public class NNTPClient extends NNTP { /** * Retrieves an article header from the currently selected newsgroup. The article is referenced by its article number. The article number and identifier - * contained in the server reply are returned through an ArticleInfo. The <code> articleId </code> field of the ArticleInfo cannot always be trusted because + * contained in the server reply are returned through an ArticleInfo. The <code>articleId</code> field of the ArticleInfo cannot always be trusted because * some NNTP servers do not correctly follow the RFC 977 reply format. * <p> * A DotTerminatedMessageReader is returned from which the article can be read. If the article does not exist, null is returned. @@ -987,7 +987,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> retrieveArticleHeader(articleId, (ArticleInfo) null) </code> Note: the return can be cast to a {@link BufferedReader} + * Same as <code>retrieveArticleHeader(articleId, (ArticleInfo) null)</code> Note: the return can be cast to a {@link BufferedReader} * * @param articleId the article id to fetch * @return the reader @@ -999,7 +999,7 @@ public class NNTPClient extends NNTP { /** * Retrieves an article header from the NNTP server. The article is referenced by its unique article identifier (including the enclosing < and >). The - * article number and identifier contained in the server reply are returned through an ArticleInfo. The <code> articleId </code> field of the ArticleInfo + * article number and identifier contained in the server reply are returned through an ArticleInfo. The <code>articleId</code> field of the ArticleInfo * cannot always be trusted because some NNTP servers do not correctly follow the RFC 977 reply format. * <p> * A DotTerminatedMessageReader is returned from which the article can be read. If the article does not exist, null is returned. @@ -1175,7 +1175,7 @@ public class NNTPClient extends NNTP { } /*** - * Same as <code> selectArticle((String) null, articleId) </code>. Useful for retrieving the current article number. + * Same as <code>selectArticle((String) null, articleId)</code>. Useful for retrieving the current article number. * * @param pointer to the article * @return true if OK @@ -1227,7 +1227,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> selectArticle(articleNumber, null) </code> + * Same as <code>selectArticle(articleNumber, null)</code> * * @param articleNumber the numger * @return true if successful @@ -1265,7 +1265,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> selectArticle(articleId, (ArticleInfo) null) </code> + * Same as <code>selectArticle(articleId, (ArticleInfo) null)</code> * * @param articleId the article's Id * @return true if successful @@ -1324,7 +1324,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> selectNewsgroup(newsgroup, null) </code> + * Same as <code>selectNewsgroup(newsgroup, null)</code> * * @param newsgroup the newsgroup name * @return true if newsgroup exist and was selected @@ -1360,7 +1360,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> selectNextArticle((ArticleInfo) null) </code> + * Same as <code>selectNextArticle((ArticleInfo) null)</code> * * @return true if successful * @throws IOException on error @@ -1372,7 +1372,7 @@ public class NNTPClient extends NNTP { /** * Select the article following the currently selected article in the currently selected newsgroup and return its number and unique id through the pointer * parameter. Because of deviating server implementations, the articleId information cannot be trusted. To obtain the article identifier, issue a - * <code> selectArticle(pointer.articleNumber, pointer) </code> immediately afterward. + * <code>selectArticle(pointer.articleNumber, pointer)</code> immediately afterward. * * @param pointer A parameter through which to return the article's number and unique id. The articleId field cannot always be trusted because of server * deviations from RFC 977 reply formats. You may set this parameter to null if you do not desire to retrieve the returned article @@ -1411,7 +1411,7 @@ public class NNTPClient extends NNTP { } /** - * Same as <code> selectPreviousArticle((ArticleInfo) null) </code> + * Same as <code>selectPreviousArticle((ArticleInfo) null)</code> * * @return true if successful * @throws IOException on error @@ -1425,7 +1425,7 @@ public class NNTPClient extends NNTP { /** * Select the article preceding the currently selected article in the currently selected newsgroup and return its number and unique id through the pointer * parameter. Because of deviating server implementations, the articleId information cannot be trusted. To obtain the article identifier, issue a - * <code> selectArticle(pointer.articleNumber, pointer) </code> immediately afterward. + * <code>selectArticle(pointer.articleNumber, pointer)</code> immediately afterward. * * @param pointer A parameter through which to return the article's number and unique id. The articleId field cannot always be trusted because of server * deviations from RFC 977 reply formats. You may set this parameter to null if you do not desire to retrieve the returned article diff --git a/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java b/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java index 1199d8fa..eca39164 100644 --- a/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java +++ b/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java @@ -168,7 +168,7 @@ public final class NewGroupsOrNewsQuery { /** * Add a newsgroup to the list of newsgroups being queried. Newsgroups added this way are only meaningful to the NEWNEWS command. Newsgroup names may - * include the <code> * </code> wildcard, as in <code>comp.lang.* </code> or <code> comp.lang.java.* </code>. Adding at least one newsgroup is mandatory for + * include the <code>*</code> wildcard, as in <code>comp.lang.*</code> or <code>comp.lang.java.*</code>. Adding at least one newsgroup is mandatory for * the NEWNEWS command. * * @param newsgroup The newsgroup to add to the list of groups to be checked for new news. @@ -229,8 +229,8 @@ public final class NewGroupsOrNewsQuery { /** * Add a newsgroup to the list of newsgroups being queried, but indicate that group should not be checked for new news. Newsgroups added this way are only - * meaningful to the NEWNEWS command. Newsgroup names may include the <code> * </code> wildcard, as in <code>comp.lang.* </code> or - * <code> comp.lang.java.* </code>. + * meaningful to the NEWNEWS command. Newsgroup names may include the <code>*</code> wildcard, as in <code>comp.lang.*</code> or + * <code>comp.lang.java.*</code>. * <p> * The following would create a query that searched for new news in all comp.lang.java newsgroups except for comp.lang.java.advocacy. * </p> diff --git a/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java b/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java index cc0a20f8..a3526616 100644 --- a/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java +++ b/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java @@ -101,7 +101,7 @@ public final class NewsgroupInfo { } /** - * Gets the posting permission of the newsgroup. This will be one of the <code> POSTING_PERMISSION </code> constants. + * Gets the posting permission of the newsgroup. This will be one of the <code>POSTING_PERMISSION</code> constants. * * @return The posting permission status of the newsgroup. */ diff --git a/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java b/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java index 2ff5d822..b5213de3 100644 --- a/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java +++ b/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java @@ -94,7 +94,7 @@ public class SimpleNNTPHeader { } /** - * Returns the address used in the <code> From: </code> header field. + * Returns the address used in the <code>From:</code> header field. * * @return The from address. */ @@ -103,7 +103,7 @@ public class SimpleNNTPHeader { } /** - * Returns the contents of the <code> Newsgroups: </code> header field. + * Returns the contents of the <code>Newsgroups:</code> header field. * * @return The comma-separated list of newsgroups to which the article is being posted. */ @@ -112,7 +112,7 @@ public class SimpleNNTPHeader { } /** - * Returns the subject used in the <code> Subject: </code> header field. + * Returns the subject used in the <code>Subject:</code> header field. * * @return The subject. */ diff --git a/src/main/java/org/apache/commons/net/pop3/POP3.java b/src/main/java/org/apache/commons/net/pop3/POP3.java index 16f56a6f..773e97d2 100644 --- a/src/main/java/org/apache/commons/net/pop3/POP3.java +++ b/src/main/java/org/apache/commons/net/pop3/POP3.java @@ -98,7 +98,7 @@ public class POP3 extends SocketClient { } /** - * Performs connection initialization and sets state to <code> AUTHORIZATION_STATE </code>. + * Performs connection initialization and sets state to <code>AUTHORIZATION_STATE</code>. */ @Override protected void _connectAction_() throws IOException { @@ -110,7 +110,7 @@ public class POP3 extends SocketClient { } /** - * Disconnects the client from the server, and sets the state to <code> DISCONNECTED_STATE </code>. The reply text information from the last issued command + * Disconnects the client from the server, and sets the state to <code>DISCONNECTED_STATE</code>. The reply text information from the last issued command * is voided to allow garbage collection of the memory used to store that information. * * @throws IOException If there is an error in disconnecting. diff --git a/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java b/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java index 878986ed..602026d7 100644 --- a/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java +++ b/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java @@ -21,13 +21,13 @@ package org.apache.commons.net.pop3; * POP3MessageInfo is used to return information about messages stored on a POP3 server. Its fields are used to mean slightly different things depending on the * information being returned. * <p> - * In response to a status command, <code> number </code> contains the number of messages in the mailbox, <code> size </code> contains the size of the mailbox - * in bytes, and <code> identifier </code> is null. + * In response to a status command, <code>number</code> contains the number of messages in the mailbox, <code>size</code> contains the size of the mailbox + * in bytes, and <code>identifier</code> is null. * <p> - * In response to a message listings, <code> number </code> contains the message number, <code> size </code> contains the size of the message in bytes, and - * <code> identifier </code> is null. + * In response to a message listings, <code>number</code> contains the message number, <code>size</code> contains the size of the message in bytes, and + * <code>identifier</code> is null. * <p> - * In response to unique identifier listings, <code> number </code> contains the message number, <code> size </code> is undefined, and <code> identifier </code> + * In response to unique identifier listings, <code>number</code> contains the message number, <code>size</code> is undefined, and <code>identifier</code> * contains the message's unique identifier. */ @@ -37,14 +37,14 @@ public final class POP3MessageInfo { public String identifier; /** - * Creates a POP3MessageInfo instance with <code>number</code> and <code> size </code> set to 0, and <code>identifier</code> set to null. + * Creates a POP3MessageInfo instance with <code>number</code> and <code>size</code> set to 0, and <code>identifier</code> set to null. */ public POP3MessageInfo() { this(0, null, 0); } /** - * Creates a POP3MessageInfo instance with <code>number</code> set to <code> num </code>, <code> size </code> set to <code> octets </code>, and + * Creates a POP3MessageInfo instance with <code>number</code> set to <code>num</code>, <code>size</code> set to <code>octets</code>, and * <code>identifier</code> set to null. * * @param num the number @@ -55,7 +55,7 @@ public final class POP3MessageInfo { } /** - * Creates a POP3MessageInfo instance with <code>number</code> set to <code> num </code>, <code> size </code> undefined, and <code>identifier</code> set to + * Creates a POP3MessageInfo instance with <code>number</code> set to <code>num</code>, <code>size</code> undefined, and <code>identifier</code> set to * <code>uid</code>. * * @param num the number diff --git a/src/main/java/org/apache/commons/net/smtp/SMTP.java b/src/main/java/org/apache/commons/net/smtp/SMTP.java index 71cf4c66..22b0b93f 100644 --- a/src/main/java/org/apache/commons/net/smtp/SMTP.java +++ b/src/main/java/org/apache/commons/net/smtp/SMTP.java @@ -41,8 +41,8 @@ import org.apache.commons.net.util.NetConstants; * You should keep in mind that the SMTP server may choose to prematurely close a connection for various reasons. The SMTP class will detect a premature SMTP * server connection closing when it receives a {@link org.apache.commons.net.smtp.SMTPReply#SERVICE_NOT_AVAILABLE SMTPReply.SERVICE_NOT_AVAILABLE } response to * a command. When that occurs, the SMTP class method encountering that reply will throw an {@link org.apache.commons.net.smtp.SMTPConnectionClosedException} . - * <code>SMTPConnectionClosedException</code> is a subclass of <code> IOException </code> and therefore need not be caught separately, but if you are going to - * catch it separately, its catch block must appear before the more general <code> IOException </code> catch block. When you encounter an + * <code>SMTPConnectionClosedException</code> is a subclass of <code>IOException</code> and therefore need not be caught separately, but if you are going to + * catch it separately, its catch block must appear before the more general <code>IOException</code> catch block. When you encounter an * {@link org.apache.commons.net.smtp.SMTPConnectionClosedException} , you must disconnect the connection with * {@link org.apache.commons.net.SocketClient#disconnect disconnect() } to properly clean up the system resources used by SMTP. Before disconnecting, you may * check the last reply code and text with {@link #getReplyCode getReplyCode }, {@link #getReplyString getReplyString }, and {@link #getReplyStrings @@ -241,7 +241,7 @@ public class SMTP extends SocketClient { /** * Returns the integer value of the reply code of the last SMTP reply. You will usually only use this method after you connect to the SMTP server to check - * that the connection was successful since <code> connect </code> is of type void. + * that the connection was successful since <code>connect</code> is of type void. * * @return The integer value of the reply code of the last SMTP reply. */ diff --git a/src/main/java/org/apache/commons/net/smtp/SMTPClient.java b/src/main/java/org/apache/commons/net/smtp/SMTPClient.java index 866cd554..eea66c79 100644 --- a/src/main/java/org/apache/commons/net/smtp/SMTPClient.java +++ b/src/main/java/org/apache/commons/net/smtp/SMTPClient.java @@ -72,8 +72,8 @@ import org.apache.commons.net.io.DotTerminatedMessageWriter; * You should keep in mind that the SMTP server may choose to prematurely close a connection for various reasons. The SMTPClient class will detect a premature * SMTP server connection closing when it receives a {@link org.apache.commons.net.smtp.SMTPReply#SERVICE_NOT_AVAILABLE SMTPReply.SERVICE_NOT_AVAILABLE } * response to a command. When that occurs, the method encountering that reply will throw an {@link org.apache.commons.net.smtp.SMTPConnectionClosedException} . - * <code>SMTPConnectionClosedException</code> is a subclass of <code> IOException </code> and therefore need not be caught separately, but if you are going to - * catch it separately, its catch block must appear before the more general <code> IOException </code> catch block. When you encounter an + * <code>SMTPConnectionClosedException</code> is a subclass of <code>IOException</code> and therefore need not be caught separately, but if you are going to + * catch it separately, its catch block must appear before the more general <code>IOException</code> catch block. When you encounter an * {@link org.apache.commons.net.smtp.SMTPConnectionClosedException} , you must disconnect the connection with {@link #disconnect disconnect() } to properly * clean up the system resources used by SMTPClient. Before disconnecting, you may check the last reply code and text with * {@link org.apache.commons.net.smtp.SMTP#getReplyCode getReplyCode }, {@link org.apache.commons.net.smtp.SMTP#getReplyString getReplyString }, and diff --git a/src/main/java/org/apache/commons/net/time/TimeTCPClient.java b/src/main/java/org/apache/commons/net/time/TimeTCPClient.java index 250e5272..7c3231e4 100644 --- a/src/main/java/org/apache/commons/net/time/TimeTCPClient.java +++ b/src/main/java/org/apache/commons/net/time/TimeTCPClient.java @@ -42,7 +42,7 @@ public final class TimeTCPClient extends SocketClient { public static final long SECONDS_1900_TO_1970 = 2208988800L; /** - * The default TimeTCPClient constructor. It merely sets the default port to <code> DEFAULT_PORT </code>. + * The default TimeTCPClient constructor. It merely sets the default port to <code>DEFAULT_PORT</code>. */ public TimeTCPClient() { setDefaultPort(DEFAULT_PORT); @@ -53,7 +53,7 @@ public final class TimeTCPClient extends SocketClient { * <p> * The server will have closed the connection at this point, so you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect } after * calling this method. To retrieve another time, you must initiate another connection with {@link org.apache.commons.net.SocketClient#connect connect } - * before calling <code> getDate() </code> again. + * before calling <code>getDate()</code> again. * * @return A Date value containing the time retrieved from the server converted to the local time zone. * @throws IOException If an error occurs while fetching the time. @@ -68,7 +68,7 @@ public final class TimeTCPClient extends SocketClient { * <p> * The server will have closed the connection at this point, so you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect } after * calling this method. To retrieve another time, you must initiate another connection with {@link org.apache.commons.net.SocketClient#connect connect } - * before calling <code> getTime() </code> again. + * before calling <code>getTime()</code> again. * * @return The time value retrieved from the server. * @throws IOException If an error occurs while fetching the time. diff --git a/src/main/java/org/apache/commons/net/time/TimeUDPClient.java b/src/main/java/org/apache/commons/net/time/TimeUDPClient.java index 0ef5927c..7ba95caf 100644 --- a/src/main/java/org/apache/commons/net/time/TimeUDPClient.java +++ b/src/main/java/org/apache/commons/net/time/TimeUDPClient.java @@ -48,7 +48,7 @@ public final class TimeUDPClient extends DatagramSocketClient { private final byte[] timeData = new byte[4]; /** - * Same as <code> getTime(host, DEFAULT_PORT); </code> + * Same as <code>getTime(host, DEFAULT_PORT);</code> * * @param host the time-server * @return the date @@ -71,7 +71,7 @@ public final class TimeUDPClient extends DatagramSocketClient { } /** - * Same as <code> getTime(host, DEFAULT_PORT); </code> + * Same as <code>getTime(host, DEFAULT_PORT);</code> * * @param host the time-server * @return the time returned from the server diff --git a/src/main/java/org/apache/commons/net/whois/WhoisClient.java b/src/main/java/org/apache/commons/net/whois/WhoisClient.java index 5fa511e5..7409c4ae 100644 --- a/src/main/java/org/apache/commons/net/whois/WhoisClient.java +++ b/src/main/java/org/apache/commons/net/whois/WhoisClient.java @@ -55,7 +55,7 @@ public final class WhoisClient extends FingerClient { public static final int DEFAULT_PORT = 43; /** - * The default whois constructor. Initializes the default port to <code> DEFAULT_PORT </code>. + * The default whois constructor. Initializes the default port to <code>DEFAULT_PORT</code>. */ public WhoisClient() { setDefaultPort(DEFAULT_PORT);