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 301e48b2 Javadoc, no need to abbreviate in documentation
301e48b2 is described below
commit 301e48b2cfe0c9e92198500eda898df6f71737d3
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 17 08:36:41 2023 -0400
Javadoc, no need to abbreviate in documentation
---
.../commons/net/imap/AuthenticatingIMAPClient.java | 6 +++---
src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java | 2 +-
src/main/java/org/apache/commons/net/ntp/TimeStamp.java | 16 ++++++++--------
.../org/apache/commons/net/pop3/ExtendedPOP3Client.java | 6 +++---
.../commons/net/smtp/AuthenticatingSMTPClient.java | 6 +++---
5 files changed, 18 insertions(+), 18 deletions(-)
diff --git
a/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
b/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
index b0c317b3..96980d55 100644
--- a/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
+++ b/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
@@ -229,11 +229,11 @@ public class AuthenticatingIMAPClient extends IMAPSClient
{
}
/**
- * Converts the given byte array to a String containing the hex values of
the bytes. For example, the byte 'A' will be converted to '41', because this is
- * the ASCII code (and the byte value) of the capital letter 'A'.
+ * Converts the given byte array to a String containing the hexadecimal
values of the bytes. For example, the byte 'A' will be converted to '41',
because
+ * this is the ASCII code (and the byte value) of the capital letter 'A'.
*
* @param a The byte array to convert.
- * @return The resulting String of hex codes.
+ * @return The resulting String of hexadecimal codes.
*/
private String convertToHexString(final byte[] a) {
final StringBuilder result = new StringBuilder(a.length * 2);
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 841244ca..17f4a777 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
@@ -218,7 +218,7 @@ public class NtpV3Impl implements NtpV3Packet {
/**
* Returns the reference id string. String cannot be null but value is
dependent on the version of the NTP spec supported and stratum level. Value can
be an
- * empty string, clock type string, IP address, or a hex string.
+ * empty string, clock type string, IP address, or a hexadecimal string.
*
* @return the reference id string.
*/
diff --git a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
index b536f913..26ada4bf 100644
--- a/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
+++ b/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
@@ -55,7 +55,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
public static final String NTP_DATE_FORMAT = "EEE, MMM dd yyyy
HH:mm:ss.SSS";
/**
- * Left-pad 8-character hex string with 0's
+ * Left-pad 8-character hexadecimal string with 0's
*
* @param buf - StringBuilder which is appended with leading 0's.
* @param l - a long.
@@ -190,12 +190,12 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
}
/**
- * Converts 64-bit NTP timestamp value to a <code>String</code>. The NTP
timestamp value is represented as hex string with seconds separated by
fractional
- * seconds by a decimal point; e.g. c1a089bd.fc904f6d == Tue, Dec 10 2002
10:41:49.986
+ * Converts 64-bit NTP timestamp value to a <code>String</code>. The NTP
timestamp value is represented as hexadecimal string with seconds separated by
+ * fractional seconds by a decimal point; e.g. c1a089bd.fc904f6d == Tue,
Dec 10 2002 10:41:49.986
*
* @param ntpTime the 64 bit timestamp
*
- * @return NTP timestamp 64-bit long value as hex string with seconds
separated by fractional seconds.
+ * @return NTP timestamp 64-bit long value as hexadecimal string with
seconds separated by fractional seconds.
*/
public static String toString(final long ntpTime) {
final StringBuilder buf = new StringBuilder();
@@ -240,7 +240,7 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
/**
* Constructs a newly allocated NTP timestamp object that represents the
value represented by the string in hexdecimal form (e.g. "c1a089bd.fc904f6d").
*
- * @param hexStamp the hex timestamp
+ * @param hexStamp the hexadecimal timestamp
*
* @throws NumberFormatException - if the string does not contain a
parsable timestamp.
*/
@@ -367,10 +367,10 @@ public class TimeStamp implements Serializable,
Comparable<TimeStamp> {
}
/**
- * Converts this <code>TimeStamp</code> object to a <code>String</code>.
The NTP timestamp 64-bit long value is represented as hex string with seconds
- * separated by fractional seconds by a decimal point; e.g.
c1a089bd.fc904f6d == Tue, Dec 10 2002 10:41:49.986
+ * Converts this <code>TimeStamp</code> object to a <code>String</code>.
The NTP timestamp 64-bit long value is represented as hexadecimal string with
+ * seconds separated by fractional seconds by a decimal point; e.g.
c1a089bd.fc904f6d == Tue, Dec 10 2002 10:41:49.986
*
- * @return NTP timestamp 64-bit long value as hex string with seconds
separated by fractional seconds.
+ * @return NTP timestamp 64-bit long value as hexadecimal string with
seconds separated by fractional seconds.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/net/pop3/ExtendedPOP3Client.java
b/src/main/java/org/apache/commons/net/pop3/ExtendedPOP3Client.java
index 9d5aab48..ce7d4db3 100644
--- a/src/main/java/org/apache/commons/net/pop3/ExtendedPOP3Client.java
+++ b/src/main/java/org/apache/commons/net/pop3/ExtendedPOP3Client.java
@@ -117,11 +117,11 @@ public class ExtendedPOP3Client extends POP3SClient {
}
/**
- * Converts the given byte array to a String containing the hex values of
the bytes. For example, the byte 'A' will be converted to '41', because this is
- * the ASCII code (and the byte value) of the capital letter 'A'.
+ * Converts the given byte array to a String containing the hexadecimal
values of the bytes. For example, the byte 'A' will be converted to '41',
because
+ * this is the ASCII code (and the byte value) of the capital letter 'A'.
*
* @param a The byte array to convert.
- * @return The resulting String of hex codes.
+ * @return The resulting String of hexadecimal codes.
*/
private String convertToHexString(final byte[] a) {
final StringBuilder result = new StringBuilder(a.length * 2);
diff --git
a/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
b/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
index 4c6123f9..478e07be 100644
--- a/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
+++ b/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
@@ -206,11 +206,11 @@ public class AuthenticatingSMTPClient extends SMTPSClient
{
}
/**
- * Converts the given byte array to a String containing the hex values of
the bytes. For example, the byte 'A' will be converted to '41', because this is
- * the ASCII code (and the byte value) of the capital letter 'A'.
+ * Converts the given byte array to a String containing the hexadecimal
values of the bytes. For example, the byte 'A' will be converted to '41',
because
+ * this is the ASCII code (and the byte value) of the capital letter 'A'.
*
* @param a The byte array to convert.
- * @return The resulting String of hex codes.
+ * @return The resulting String of hexadecimal codes.
*/
private String convertToHexString(final byte[] a) {
final StringBuilder result = new StringBuilder(a.length * 2);
