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 cf742df9 Normalize setter Javadoc
cf742df9 is described below
commit cf742df9e0fa062590d3c5550cf293dd72ae4037
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 07:11:10 2023 -0400
Normalize setter Javadoc
---
.../apache/commons/net/DatagramSocketClient.java | 8 +++---
.../java/org/apache/commons/net/SocketClient.java | 6 ++---
src/main/java/org/apache/commons/net/ftp/FTP.java | 4 +--
.../java/org/apache/commons/net/ftp/FTPClient.java | 24 ++++++++---------
.../org/apache/commons/net/ftp/FTPSClient.java | 4 +--
.../net/ftp/parser/FTPTimestampParserImpl.java | 2 +-
.../org/apache/commons/net/imap/IMAPSClient.java | 2 +-
.../java/org/apache/commons/net/ntp/NtpV3Impl.java | 30 +++++++++++-----------
.../org/apache/commons/net/ntp/NtpV3Packet.java | 26 +++++++++----------
.../java/org/apache/commons/net/pop3/POP3.java | 2 +-
.../org/apache/commons/net/pop3/POP3SClient.java | 2 +-
.../org/apache/commons/net/smtp/SMTPClient.java | 4 +--
.../org/apache/commons/net/smtp/SMTPSClient.java | 2 +-
.../org/apache/commons/net/tftp/TFTPServer.java | 8 +++---
14 files changed, 62 insertions(+), 62 deletions(-)
diff --git a/src/main/java/org/apache/commons/net/DatagramSocketClient.java
b/src/main/java/org/apache/commons/net/DatagramSocketClient.java
index 0ee73e4b..1a34c79f 100644
--- a/src/main/java/org/apache/commons/net/DatagramSocketClient.java
+++ b/src/main/java/org/apache/commons/net/DatagramSocketClient.java
@@ -250,7 +250,7 @@ public abstract class DatagramSocketClient implements
AutoCloseable {
}
/**
- * Set the default timeout in to use when opening a socket. After a call
to open, the timeout for the socket is set using this value. This
+ * Sets the default timeout in to use when opening a socket. After a call
to open, the timeout for the socket is set using this value. This
* method should be used prior to a call to {@link #open open()} and
should not be confused with {@link #setSoTimeout setSoTimeout()} which operates
on the
* currently open socket. _timeout_ contains the new timeout value.
*
@@ -261,7 +261,7 @@ public abstract class DatagramSocketClient implements
AutoCloseable {
}
/**
- * Set the default timeout in milliseconds to use when opening a socket.
After a call to open, the timeout for the socket is set using this value. This
+ * Sets the default timeout in milliseconds to use when opening a socket.
After a call to open, the timeout for the socket is set using this value. This
* method should be used prior to a call to {@link #open open()} and
should not be confused with {@link #setSoTimeout setSoTimeout()} which operates
on the
* currently open socket. _timeout_ contains the new timeout value.
*
@@ -274,7 +274,7 @@ public abstract class DatagramSocketClient implements
AutoCloseable {
}
/**
- * Set the timeout duration of a currently open connection. Only call this
method after a connection has been opened by {@link #open open()}.
+ * Sets the timeout duration of a currently open connection. Only call
this method after a connection has been opened by {@link #open open()}.
*
* @param timeout The timeout in milliseconds to use for the currently
open datagram socket connection.
* @throws SocketException if an error setting the timeout.
@@ -285,7 +285,7 @@ public abstract class DatagramSocketClient implements
AutoCloseable {
}
/**
- * Set the timeout in milliseconds of a currently open connection. Only
call this method after a connection has been opened by {@link #open open()}.
+ * Sets the timeout in milliseconds of a currently open connection. Only
call this method after a connection has been opened by {@link #open open()}.
*
* @param timeout The timeout in milliseconds to use for the currently
open datagram socket connection.
* @throws SocketException if an error setting the timeout.
diff --git a/src/main/java/org/apache/commons/net/SocketClient.java
b/src/main/java/org/apache/commons/net/SocketClient.java
index a860f444..213644d2 100644
--- a/src/main/java/org/apache/commons/net/SocketClient.java
+++ b/src/main/java/org/apache/commons/net/SocketClient.java
@@ -631,7 +631,7 @@ public abstract class SocketClient {
}
/**
- * Set the default timeout in milliseconds to use when opening a socket.
This value is only used previous to a call to {@link #connect connect()} and
should
+ * Sets the default timeout in milliseconds to use when opening a socket.
This value is only used previous to a call to {@link #connect connect()} and
should
* not be confused with {@link #setSoTimeout setSoTimeout()} which
operates on the currently opened socket. _timeout_ contains the new timeout
value.
*
* @param timeout The timeout in milliseconds to use for the socket
connection.
@@ -678,7 +678,7 @@ public abstract class SocketClient {
}
/**
- * Set the underlying socket send buffer size.
+ * Sets the underlying socket send buffer size.
*
* @param size The size of the buffer in bytes.
* @throws SocketException never thrown, but subclasses might want to do so
@@ -730,7 +730,7 @@ public abstract class SocketClient {
}
/**
- * Set the timeout in milliseconds of a currently open connection. Only
call this method after a connection has been opened by {@link #connect
connect()}.
+ * Sets the timeout in milliseconds of a currently open connection. Only
call this method after a connection has been opened by {@link #connect
connect()}.
* <p>
* To set the initial timeout, use {@link #setDefaultTimeout(int)} instead.
*
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 9648355c..9c860fdb 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTP.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTP.java
@@ -1235,7 +1235,7 @@ public class FTP extends SocketClient {
}
/**
- * Set strict multiline parsing.
+ * Sets strict multiline parsing.
*
* @param strictMultilineParsing the setting
* @since 2.0
@@ -1245,7 +1245,7 @@ public class FTP extends SocketClient {
}
/**
- * Set strict non-multiline parsing.
+ * Sets strict non-multiline parsing.
* <p>
* If true, it requires the 3-digit code be followed by space and some
text. <br>
* If false, only the 3-digit code is required (as was the case for
versions up to 3.5)
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
index d6e6e2c6..914a3782 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -1312,7 +1312,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the current data connection mode to
<code>ACTIVE_LOCAL_DATA_CONNECTION_MODE</code>. No communication with the FTP
server is conducted, but this
+ * Sets the current data connection mode to
<code>ACTIVE_LOCAL_DATA_CONNECTION_MODE</code>. No communication with the FTP
server is conducted, but this
* causes all future data transfers to require the FTP server to connect
to the client's data port. Additionally, to accommodate differences between
socket
* implementations on different platforms, this method causes the client
to issue a PORT command before every data transfer.
*/
@@ -1323,7 +1323,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the current data connection mode to <code>
PASSIVE_LOCAL_DATA_CONNECTION_MODE </code>. Use this method only for data
transfers between the client and
+ * Sets the current data connection mode to <code>
PASSIVE_LOCAL_DATA_CONNECTION_MODE </code>. Use this method only for data
transfers between the client and
* server. This method causes a PASV (or EPSV) command to be issued to the
server before the opening of every data connection, telling the server to open a
* data port to which the client will connect to conduct data transfers.
The FTPClient will stay in <code> PASSIVE_LOCAL_DATA_CONNECTION_MODE </code>
until
* the mode is changed by calling some other method such as {@link
#enterLocalActiveMode enterLocalActiveMode() }
@@ -1339,7 +1339,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the current data connection mode to <code>
ACTIVE_REMOTE_DATA_CONNECTION </code>. Use this method only for server to
server data transfers. This
+ * Sets the current data connection mode to <code>
ACTIVE_REMOTE_DATA_CONNECTION </code>. Use this method only for server to
server data transfers. This
* method issues a PORT command to the server, indicating the other server
and port to which it should connect for data transfers. You must call this
method
* before EVERY server to server transfer attempt. The FTPClient will NOT
automatically continue to issue PORT commands. You also must remember to call
* {@link #enterLocalActiveMode enterLocalActiveMode() } if you wish to
return to the normal data connection mode.
@@ -1363,7 +1363,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the current data connection mode to <code>
PASSIVE_REMOTE_DATA_CONNECTION_MODE </code>. Use this method only for server to
server data transfers.
+ * Sets the current data connection mode to <code>
PASSIVE_REMOTE_DATA_CONNECTION_MODE </code>. Use this method only for server to
server data transfers.
* This method issues a PASV command to the server, telling it to open a
data port to which the active server will connect to conduct data transfers. You
* must call this method before EVERY server to server transfer attempt.
The FTPClient will NOT automatically continue to issue PASV commands. You also
must
* remember to call {@link #enterLocalActiveMode enterLocalActiveMode() }
if you wish to return to the normal data connection mode.
@@ -1677,7 +1677,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the local IP address in passive mode. Useful when there are
multiple network cards.
+ * Sets the local IP address in passive mode. Useful when there are
multiple network cards.
*
* @return The local IP address in passive mode.
*/
@@ -2870,7 +2870,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the external IP address in active mode. Useful when there are
multiple network cards.
+ * Sets the external IP address in active mode. Useful when there are
multiple network cards.
*
* @param ipAddress The external IP address of this machine.
* @throws UnknownHostException if the ipAddress cannot be resolved
@@ -2881,7 +2881,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the client side port range in active mode.
+ * Sets the client side port range in active mode.
*
* @param minPort The lowest available port (inclusive).
* @param maxPort The highest available port (inclusive).
@@ -2904,7 +2904,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the internal buffer size for buffered data streams.
+ * Sets the internal buffer size for buffered data streams.
*
* @param bufSize The size of the buffer. Use a non-positive value to use
the default.
*/
@@ -2967,7 +2967,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the listener to be used when performing store/retrieve operations.
The default value (if not set) is {@code null}.
+ * Sets the listener to be used when performing store/retrieve operations.
The default value (if not set) is {@code null}.
*
* @param listener to be used, may be {@code null} to disable
* @since 3.0
@@ -3153,7 +3153,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the local IP address to use in passive mode. Useful when there are
multiple network cards.
+ * Sets the local IP address to use in passive mode. Useful when there are
multiple network cards.
*
* @param inetAddress The local IP address of this machine.
*/
@@ -3162,7 +3162,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set the local IP address to use in passive mode. Useful when there are
multiple network cards.
+ * Sets the local IP address to use in passive mode. Useful when there are
multiple network cards.
*
* @param ipAddress The local IP address of this machine.
* @throws UnknownHostException if the ipAddress cannot be resolved
@@ -3258,7 +3258,7 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Set whether to use EPSV with IPv4. Might be worth enabling in some
circumstances.
+ * Sets whether to use EPSV with IPv4. Might be worth enabling in some
circumstances.
*
* For example, when using IPv4 with NAT it may work with some rare
configurations. E.g. if FTP server has a static PASV address (external network)
and the
* client is coming from another internal network. In that case the data
connection after PASV command would fail, while EPSV would make the client
succeed
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
index edab7eb3..98457ac7 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
@@ -906,7 +906,7 @@ public class FTPSClient extends FTPClient {
}
/**
- * Set AUTH command use value. This processing is done before connected
processing.
+ * Sets AUTH command use value. This processing is done before connected
processing.
*
* @param auth AUTH command use value.
*/
@@ -964,7 +964,7 @@ public class FTPSClient extends FTPClient {
}
/**
- * Set a {@link KeyManager} to use
+ * Sets a {@link KeyManager} to use
*
* @param keyManager The KeyManager implementation to set.
* @see org.apache.commons.net.util.KeyManagerUtils
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
index 516be6fb..15e6e1cc 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
@@ -133,7 +133,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
/**
* Implementation of the {@link Configurable Configurable} interface.
Configures this <code>FTPTimestampParser</code> according to the following
logic:
* <p>
- * Set up the {@link
FTPClientConfig#setDefaultDateFormatStr(java.lang.String) defaultDateFormat}
and optionally the
+ * Sets up the {@link
FTPClientConfig#setDefaultDateFormatStr(java.lang.String) defaultDateFormat}
and optionally the
* {@link FTPClientConfig#setRecentDateFormatStr(String) recentDateFormat}
to values supplied in the config based on month names configured as follows:
* </p>
* <ul>
diff --git a/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
b/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
index 5bd86db3..ce4628ef 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
@@ -346,7 +346,7 @@ public class IMAPSClient extends IMAPClient {
}
/**
- * Set a {@link KeyManager} to use.
+ * Sets a {@link KeyManager} to use.
*
* @param newKeyManager The KeyManager implementation to set.
* @see org.apache.commons.net.util.KeyManagerUtils
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
index 4b49531d..baddddc5 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
@@ -398,7 +398,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set the contents of this object from source datagram packet.
+ * Sets the contents of this object from source datagram packet.
*
* @param srcDp source DatagramPacket to copy contents from, never null.
* @throws IllegalArgumentException if srcDp is null or byte length is
less than minimum length of 48 bytes
@@ -422,7 +422,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set integer value at index position.
+ * Sets integer value at index position.
*
* @param idx index position
* @param value 32-bit int value
@@ -435,7 +435,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set leap indicator as defined in RFC-1305.
+ * Sets leap indicator as defined in RFC-1305.
*
* @param li leap indicator.
*/
@@ -445,7 +445,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set mode as defined in RFC-1305.
+ * Sets mode as defined in RFC-1305.
*
* @param mode the mode to set
*/
@@ -455,7 +455,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set originate timestamp given NTP TimeStamp object. If <code>ts</code>
is null then zero time is used.
+ * Sets originate timestamp given NTP TimeStamp object. If <code>ts</code>
is null then zero time is used.
*
* @param ts NTP timestamp
*/
@@ -465,7 +465,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set poll interval as defined in RFC-1305.
+ * Sets poll interval as defined in RFC-1305.
*
* @param poll poll interval.
*/
@@ -475,7 +475,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set precision as defined in RFC-1305.
+ * Sets precision as defined in RFC-1305.
*
* @param precision the precision to set
* @since 3.4
@@ -486,7 +486,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set receive timestamp given NTP TimeStamp object. If <code>ts</code> is
null then zero time is used.
+ * Sets receive timestamp given NTP TimeStamp object. If <code>ts</code>
is null then zero time is used.
*
* @param ts timestamp
*/
@@ -496,7 +496,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set reference clock identifier field with 32-bit unsigned integer
value. See RFC-1305 for description.
+ * Sets reference clock identifier field with 32-bit unsigned integer
value. See RFC-1305 for description.
*
* @param refId reference clock identifier.
*/
@@ -506,7 +506,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set Reference time with NTP timestamp. If <code>ts</code> is null then
zero time is used.
+ * Sets Reference time with NTP timestamp. If <code>ts</code> is null then
zero time is used.
*
* @param ts NTP timestamp
*/
@@ -516,7 +516,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set root delay as defined in RFC-1305.
+ * Sets root delay as defined in RFC-1305.
*
* @param delay root delay
* @since 3.4
@@ -527,7 +527,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set root dispersion as defined in RFC-1305.
+ * Sets root dispersion as defined in RFC-1305.
*
* @param dispersion root dispersion
* @since 3.4
@@ -538,7 +538,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set stratum level as defined in RFC-1305.
+ * Sets stratum level as defined in RFC-1305.
*
* @param stratum stratum level.
*/
@@ -565,7 +565,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set transmit time with NTP timestamp. If <code>ts</code> is null then
zero time is used.
+ * Sets transmit time with NTP timestamp. If <code>ts</code> is null then
zero time is used.
*
* @param ts NTP timestamp
*/
@@ -575,7 +575,7 @@ public class NtpV3Impl implements NtpV3Packet {
}
/**
- * Set NTP version as defined in RFC-1305.
+ * Sets NTP version as defined in RFC-1305.
*
* @param version NTP version.
*/
diff --git a/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
b/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
index a43aa9b9..6b6ef9d5 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
@@ -179,42 +179,42 @@ public interface NtpV3Packet {
int getVersion();
/**
- * Set the contents of this object from the datagram packet
+ * Sets the contents of this object from the datagram packet
*
* @param dp the packet
*/
void setDatagramPacket(DatagramPacket dp);
/**
- * Set leap indicator.
+ * Sets leap indicator.
*
* @param li - leap indicator code
*/
void setLeapIndicator(int li);
/**
- * Set mode as defined in RFC-1305
+ * Sets mode as defined in RFC-1305
*
* @param mode the mode to set
*/
void setMode(int mode);
/**
- * Set originate timestamp given NTP TimeStamp object.
+ * Sets originate timestamp given NTP TimeStamp object.
*
* @param ts - timestamp
*/
void setOriginateTimeStamp(TimeStamp ts);
/**
- * Set poll interval as defined in RFC-1305. Field range between
NTP_MINPOLL and NTP_MAXPOLL.
+ * Sets poll interval as defined in RFC-1305. Field range between
NTP_MINPOLL and NTP_MAXPOLL.
*
* @param poll the interval to set
*/
void setPoll(int poll);
/**
- * Set precision as defined in RFC-1305
+ * Sets precision as defined in RFC-1305
*
* @param precision Precision
* @since 3.4
@@ -222,28 +222,28 @@ public interface NtpV3Packet {
void setPrecision(int precision);
/**
- * Set receive timestamp given NTP TimeStamp object.
+ * Sets receive timestamp given NTP TimeStamp object.
*
* @param ts - timestamp
*/
void setReceiveTimeStamp(TimeStamp ts);
/**
- * Set reference clock identifier field.
+ * Sets reference clock identifier field.
*
* @param refId the clock id field to set
*/
void setReferenceId(int refId);
/**
- * Set the reference timestamp given NTP TimeStamp object.
+ * Sets the reference timestamp given NTP TimeStamp object.
*
* @param ts - timestamp
*/
void setReferenceTime(TimeStamp ts);
/**
- * Set root delay as defined in RFC-1305
+ * Sets root delay as defined in RFC-1305
*
* @param delay the delay to set
* @since 3.4
@@ -258,21 +258,21 @@ public interface NtpV3Packet {
void setRootDispersion(int dispersion);
/**
- * Set stratum as defined in RFC-1305
+ * Sets stratum as defined in RFC-1305
*
* @param stratum the stratum to set
*/
void setStratum(int stratum);
/**
- * Set the {@code transmit} timestamp given NTP TimeStamp object.
+ * Sets the {@code transmit} timestamp given NTP TimeStamp object.
*
* @param ts - timestamp
*/
void setTransmitTime(TimeStamp ts);
/**
- * Set version as defined in RFC-1305
+ * Sets version as defined in RFC-1305
*
* @param version the version to set
*/
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 1dc2fbff..16f56a6f 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3.java
@@ -295,7 +295,7 @@ public class POP3 extends SocketClient {
}
/**
- * Set the internal POP3 state.
+ * Sets the internal POP3 state.
*
* @param state the new state. This must be one of the <code>_STATE</code>
constants.
*/
diff --git a/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
b/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
index d6634271..e21053df 100644
--- a/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
+++ b/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
@@ -341,7 +341,7 @@ public class POP3SClient extends POP3Client {
}
/**
- * Set a {@link KeyManager} to use.
+ * Sets a {@link KeyManager} to use.
*
* @param newKeyManager The KeyManager implementation to set.
* @see org.apache.commons.net.util.KeyManagerUtils
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 0cbd6ed2..e0dadedc 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTPClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTPClient.java
@@ -406,7 +406,7 @@ public class SMTPClient extends SMTP {
}
/**
- * Set the sender of a message using the SMTP MAIL command, specifying a
reverse relay path. The sender must be set first before any recipients may be
+ * Sets the sender of a message using the SMTP MAIL command, specifying a
reverse relay path. The sender must be set first before any recipients may be
* specified, otherwise the mail server will reject your commands.
*
* @param path The reverse relay path pointing back to the sender.
@@ -421,7 +421,7 @@ public class SMTPClient extends SMTP {
}
/**
- * Set the sender of a message using the SMTP MAIL command, specifying the
sender's email address. The sender must be set first before any recipients may
be
+ * Sets the sender of a message using the SMTP MAIL command, specifying
the sender's email address. The sender must be set first before any recipients
may be
* specified, otherwise the mail server will reject your commands.
*
* @param address The sender's email address.
diff --git a/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
b/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
index 9dbcf827..0dc09a6b 100644
--- a/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
@@ -350,7 +350,7 @@ public class SMTPSClient extends SMTPClient {
}
/**
- * Set a {@link KeyManager} to use.
+ * Sets a {@link KeyManager} to use.
*
* @param newKeyManager The KeyManager implementation to set.
* @see org.apache.commons.net.util.KeyManagerUtils
diff --git a/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
b/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
index ffd26d72..7a5c9c04 100644
--- a/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
+++ b/src/test/java/org/apache/commons/net/tftp/TFTPServer.java
@@ -730,7 +730,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
}
/**
- * Set the stream object to log debug / informational messages. By
default, this is a no-op
+ * Sets the stream object to log debug / informational messages. By
default, this is a no-op
*
* @param log the stream to use for logging
*/
@@ -739,7 +739,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
}
/**
- * Set the stream object to log error messsages. By default, this is a
no-op
+ * Sets the stream object to log error messsages. By default, this is a
no-op
*
* @param logError the stream to use for logging errors
*/
@@ -748,7 +748,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
}
/**
- * Set the max number of retries in response to a timeout. Default 3. Min
0.
+ * Sets the max number of retries in response to a timeout. Default 3. Min
0.
*
* @param retries number of retries, must be > 0
* @throws IllegalArgumentException if {@code retries} is less than 0.
@@ -761,7 +761,7 @@ public class TFTPServer implements Runnable, AutoCloseable {
}
/**
- * Set the socket timeout in milliseconds used in transfers.
+ * Sets the socket timeout in milliseconds used in transfers.
* <p>
* Defaults to the value {@link TFTP#DEFAULT_TIMEOUT}. Minimum value of 10.
* </p>
