Skip to content

Commit

Permalink
Fix Jaavdoc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
@garydgregory
garydgregory committed Sep 12, 2023
1 parent 4fc77b5 commit c5efbb4
Showing 1 changed file with 0 additions and 23 deletions.
23 changes: 0 additions & 23 deletions src/main/java/org/apache/commons/net/smtp/SMTP.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ protected void _connectAction_() throws IOException {

/**
* A convenience method to send the SMTP DATA command to the server, receive the reply, and return the reply code.
* <p>
*
* @return The reply code received from the server.
* @throws SMTPConnectionClosedException If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason
Expand All @@ -135,7 +134,6 @@ public int data() throws IOException {
/**
* Closes the connection to the SMTP server and sets to null some internal data so that the memory may be reclaimed by the garbage collector. The reply text
* and code information from the last command is voided so that the memory it used may be reclaimed.
* <p>
*
* @throws IOException If an error occurs while disconnecting.
*/
Expand All @@ -151,7 +149,6 @@ public void disconnect() throws IOException {

/**
* A convenience method to send the SMTP VRFY command to the server, receive the reply, and return the reply code.
* <p>
*
* @param name The name to expand.
* @return The reply code received from the server.
Expand All @@ -176,7 +173,6 @@ protected ProtocolCommandSupport getCommandSupport() {
* Fetches a reply from the SMTP server and returns the integer reply code. After calling this method, the actual reply text can be accessed from either
* calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }. Only use this method if you are implementing your own SMTP
* client or if you need to fetch a secondary response from the SMTP server.
* <p>
*
* @return The integer value of the reply code of the fetched SMTP reply.
* @throws SMTPConnectionClosedException If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason
Expand Down Expand Up @@ -243,7 +239,6 @@ public int getReply() throws IOException {
/**
* 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.
* <p>
*
* @return The integer value of the reply code of the last SMTP reply.
*/
Expand All @@ -253,7 +248,6 @@ public int getReplyCode() {

/**
* Returns the entire text of the last SMTP server response exactly as it was received, including all end of line markers in NETASCII format.
* <p>
*
* @return The entire text from the last SMTP response as a String.
*/
Expand Down Expand Up @@ -290,7 +284,6 @@ public String[] getReplyStrings() {

/**
* A convenience method to send the SMTP HELO command to the server, receive the reply, and return the reply code.
* <p>
*
* @param hostname The hostname of the sender.
* @return The reply code received from the server.
Expand All @@ -305,7 +298,6 @@ public int helo(final String hostname) throws IOException {

/**
* A convenience method to send the SMTP HELP command to the server, receive the reply, and return the reply code.
* <p>
*
* @return The reply code received from the server.
* @throws SMTPConnectionClosedException If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason
Expand All @@ -319,7 +311,6 @@ public int help() throws IOException {

/**
* A convenience method to send the SMTP HELP command to the server, receive the reply, and return the reply code.
* <p>
*
* @param command The command name on which to request help.
* @return The reply code received from the server.
Expand All @@ -334,7 +325,6 @@ public int help(final String command) throws IOException {

/**
* A convenience method to send the SMTP MAIL command to the server, receive the reply, and return the reply code.
* <p>
*
* @param reversePath The reverse path.
* @return The reply code received from the server.
Expand All @@ -349,7 +339,6 @@ public int mail(final String reversePath) throws IOException {

/**
* A convenience method to send the SMTP NOOP command to the server, receive the reply, and return the reply code.
* <p>
*
* @return The reply code received from the server.
* @throws SMTPConnectionClosedException If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason
Expand All @@ -363,7 +352,6 @@ public int noop() throws IOException {

/**
* A convenience method to send the SMTP QUIT command to the server, receive the reply, and return the reply code.
* <p>
*
* @return The reply code received from the server.
* @throws SMTPConnectionClosedException If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason
Expand All @@ -377,7 +365,6 @@ public int quit() throws IOException {

/**
* A convenience method to send the SMTP RCPT command to the server, receive the reply, and return the reply code.
* <p>
*
* @param forwardPath The forward path.
* @return The reply code received from the server.
Expand All @@ -404,7 +391,6 @@ public void removeProtocolCommandistener(final org.apache.commons.net.ProtocolCo

/**
* A convenience method to send the SMTP RSET command to the server, receive the reply, and return the reply code.
* <p>
*
* @return The reply code received from the server.
* @throws SMTPConnectionClosedException If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason
Expand All @@ -418,7 +404,6 @@ public int rset() throws IOException {

/**
* A convenience method to send the SMTP SAML command to the server, receive the reply, and return the reply code.
* <p>
*
* @param reversePath The reverse path.
* @return The reply code received from the server.
Expand All @@ -433,7 +418,6 @@ public int saml(final String reversePath) throws IOException {

/**
* A convenience method to send the SMTP SEND command to the server, receive the reply, and return the reply code.
* <p>
*
* @param reversePath The reverse path.
* @return The reply code received from the server.
Expand All @@ -449,7 +433,6 @@ public int send(final String reversePath) throws IOException {
/**
* Sends an SMTP command with no arguments to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed
* information, the actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* <p>
*
* @param command The SMTPCommand constant corresponding to the SMTP command to send.
* @return The integer value of the SMTP reply code returned by the server in response to the command.
Expand All @@ -465,7 +448,6 @@ public int sendCommand(final int command) throws IOException {
/**
* Sends an SMTP command to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the
* actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* <p>
*
* @param command The SMTPCommand constant corresponding to the SMTP command to send.
* @param args The arguments to the SMTP command. If this parameter is set to null, then the command is sent with no argument.
Expand Down Expand Up @@ -494,7 +476,6 @@ private int sendCommand(final int command, final String args, final boolean incl
/**
* Sends an SMTP command with no arguments to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed
* information, the actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* <p>
*
* @param command The text representation of the SMTP command to send.
* @return The integer value of the SMTP reply code returned by the server in response to the command.
Expand All @@ -510,7 +491,6 @@ public int sendCommand(final String command) throws IOException {
/**
* Sends an SMTP command to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the
* actual reply text can be accessed by calling {@link #getReplyString getReplyString } or {@link #getReplyStrings getReplyStrings }.
* <p>
*
* @param command The text representation of the SMTP command to send.
* @param args The arguments to the SMTP command. If this parameter is set to null, then the command is sent with no argument.
Expand Down Expand Up @@ -557,7 +537,6 @@ private int sendCommand(final String command, final String args, final boolean i

/**
* A convenience method to send the SMTP SOML command to the server, receive the reply, and return the reply code.
* <p>
*
* @param reversePath The reverse path.
* @return The reply code received from the server.
Expand All @@ -572,7 +551,6 @@ public int soml(final String reversePath) throws IOException {

/**
* A convenience method to send the SMTP TURN command to the server, receive the reply, and return the reply code.
* <p>
*
* @return The reply code received from the server.
* @throws SMTPConnectionClosedException If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason
Expand All @@ -586,7 +564,6 @@ public int turn() throws IOException {

/**
* A convenience method to send the SMTP VRFY command to the server, receive the reply, and return the reply code.
* <p>
*
* @param user The user address to verify.
* @return The reply code received from the server.
Expand Down

0 comments on commit c5efbb4

Please sign in to comment.