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 4d1e06a1 Fix typos in Javadoc and comments
4d1e06a1 is described below
commit 4d1e06a106af316e516713d1abfe017bd65c0edf
Author: Gary D. Gregory <[email protected]>
AuthorDate: Sat Feb 15 09:35:54 2025 -0500
Fix typos in Javadoc and comments
---
src/main/java/org/apache/commons/net/bsd/RCommandClient.java | 4 ++--
src/main/java/org/apache/commons/net/bsd/RExecClient.java | 2 +-
src/main/java/org/apache/commons/net/pop3/POP3Client.java | 6 +++---
src/main/java/org/apache/commons/net/smtp/SMTP.java | 2 +-
src/main/java/org/apache/commons/net/smtp/SMTPClient.java | 2 +-
5 files changed, 8 insertions(+), 8 deletions(-)
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 c1a2a71e..af4bace4 100644
--- a/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
+++ b/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
@@ -52,7 +52,7 @@ import org.apache.commons.net.io.SocketInputStream;
* 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} parameter of {@link #rcommand rcommand() } to
{@code true}. 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() } .
+ * to through the output stream returned by {@link
org.apache.commons.net.bsd.RExecClient#getOutputStream getOutputStream()}.
* </p>
*
* @see org.apache.commons.net.SocketClient
@@ -270,7 +270,7 @@ public class RCommandClient extends RExecClient {
* be so. RCommandClient will also do a simple security check when it
accepts a connection for this error stream. If the connection does not
originate from
* the remote server, an IOException will be thrown. This serves as a
simple protection against possible hijacking of the error stream by an attacker
* monitoring the rexec() negotiation. You may disable this behavior with
{@link org.apache.commons.net.bsd.RExecClient#setRemoteVerificationEnabled
- * setRemoteVerificationEnabled()} .
+ * setRemoteVerificationEnabled()}.
* </p>
*
* @param localUser The user account on the local machine that is
requesting the command execution.
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 1e173f8e..fc469eee 100644
--- a/src/main/java/org/apache/commons/net/bsd/RExecClient.java
+++ b/src/main/java/org/apache/commons/net/bsd/RExecClient.java
@@ -175,7 +175,7 @@ public class RExecClient extends SocketClient {
* which standard error will be transmitted. RExecClient will do a simple
security check when it accepts a connection for this error stream. If the
* connection does not originate from the remote server, an IOException
will be thrown. This serves as a simple protection against possible hijacking
of the
* error stream by an attacker monitoring the rexec() negotiation. You may
disable this behavior with {@link #setRemoteVerificationEnabled
- * setRemoteVerificationEnabled()} .
+ * setRemoteVerificationEnabled()}.
*
* @param user The account name on the server through which to
execute the command.
* @param password The plain text password of the user account.
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3Client.java
b/src/main/java/org/apache/commons/net/pop3/POP3Client.java
index cf6ad24a..e382d798 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3Client.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3Client.java
@@ -159,7 +159,7 @@ public class POP3Client extends POP3 {
}
/**
- * List all messages. A list attempt can only succeed if the client is in
the {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE
TRANSACTION_STATE} .
+ * List all messages. A list attempt can only succeed if the client is in
the {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE
TRANSACTION_STATE}.
* Returns an array of POP3MessageInfo instances, each containing the
number of a message and its size in bytes. If there are no messages, this method
* returns a zero length array. If the list attempt fails, it returns null.
*
@@ -340,7 +340,7 @@ public class POP3Client extends POP3 {
/**
* Send a NOOP command to the POP3 server. This is useful for keeping a
connection alive since most POP3 servers will time out after 10 minutes of
- * inactivity. A noop attempt will only succeed if the client is in the
{@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE } .
+ * inactivity. A noop attempt will only succeed if the client is in the
{@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE TRANSACTION_STATE }.
*
* @return True if the noop attempt was successful, false if not.
* @throws IOException If a network I/O error occurs in the process of
sending the NOOP command.
@@ -354,7 +354,7 @@ public class POP3Client extends POP3 {
/**
* Reset the POP3 session. This is useful for undoing any message
deletions that may have been performed. A reset attempt can only succeed if the
client is
- * in the {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE
TRANSACTION_STATE } .
+ * in the {@link org.apache.commons.net.pop3.POP3#TRANSACTION_STATE
TRANSACTION_STATE }.
*
* @return True if the reset attempt was successful, false if not.
* @throws IOException If a network I/O error occurs in the process of
sending the reset command.
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 3ec3d1f8..ee6e7cf6 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTP.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTP.java
@@ -40,7 +40,7 @@ import org.apache.commons.net.util.NetConstants;
* <p>
* 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}
.
+ * a command. When that occurs, the SMTP class method encountering that reply
will throw an {@link org.apache.commons.net.smtp.SMTPConnectionClosedException}.
* {@code SMTPConnectionClosedException} is a subclass of {@code IOException}
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} catch block. When you encounter an
* {@link org.apache.commons.net.smtp.SMTPConnectionClosedException} , you
must disconnect the connection with
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 1bf2fb4a..04bbd48d 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTPClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTPClient.java
@@ -71,7 +71,7 @@ import org.apache.commons.net.io.DotTerminatedMessageWriter;
* <p>
* 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}
.
+ * response to a command. When that occurs, the method encountering that reply
will throw an {@link org.apache.commons.net.smtp.SMTPConnectionClosedException}.
* {@code SMTPConnectionClosedException} is a subclass of {@code IOException}
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} catch block. When you encounter an
* {@link org.apache.commons.net.smtp.SMTPConnectionClosedException} , you
must disconnect the connection with {@link #disconnect disconnect() } to
properly
