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 8a37f9bf Javadoc
8a37f9bf is described below
commit 8a37f9bf5550936301cdc0d59fa1000288886f2a
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sat May 18 10:04:20 2024 -0400
Javadoc
---
src/main/java/org/apache/commons/net/ftp/FTPClient.java | 4 ++--
.../commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java | 2 +-
.../org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java | 2 +-
.../java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java | 6 ++++--
.../java/org/apache/commons/net/ftp/parser/NTFTPEntryParser.java | 5 +++--
.../org/apache/commons/net/ftp/parser/NetwareFTPEntryParser.java | 6 ++++--
.../java/org/apache/commons/net/ftp/parser/OS2FTPEntryParser.java | 6 ++++--
src/main/java/org/apache/commons/net/imap/IMAP.java | 2 +-
src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java | 2 +-
src/main/java/org/apache/commons/net/util/Base64.java | 1 -
10 files changed, 21 insertions(+), 15 deletions(-)
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 f5099936..610320bc 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -1188,10 +1188,10 @@ public class FTPClient extends FTP implements
Configurable {
}
/**
- * Implementation of the {@link Configurable Configurable} interface. In
the case of this class, configuring merely makes the config object available for
+ * Implements the {@link Configurable} interface. In the case of this
class, configuring merely makes the config object available for
* the factory methods that construct parsers.
*
- * @param config {@link FTPClientConfig FTPClientConfig} object used to
provide non-standard configurations to the parser.
+ * @param config {@link FTPClientConfig} object used to provide
non-standard configurations to the parser.
* @since 1.4
*/
@Override
diff --git
a/src/main/java/org/apache/commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java
b/src/main/java/org/apache/commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java
index 3ff88f09..059a92cb 100644
---
a/src/main/java/org/apache/commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java
+++
b/src/main/java/org/apache/commons/net/ftp/parser/ConfigurableFTPFileEntryParserImpl.java
@@ -60,7 +60,7 @@ public abstract class ConfigurableFTPFileEntryParserImpl
extends RegexFTPFileEnt
}
/**
- * Implementation of the {@link Configurable Configurable} interface.
Configures this parser by delegating to the underlying Configurable
FTPTimestampParser
+ * Implements the {@link Configurable Configurable} interface. Configures
this parser by delegating to the underlying Configurable FTPTimestampParser
* implementation, ' passing it the supplied {@link FTPClientConfig
FTPClientConfig} if that is non-null or a default configuration defined by each
concrete
* subclass.
*
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 69d4969e..56dafbf7 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
@@ -131,7 +131,7 @@ public class FTPTimestampParserImpl implements
FTPTimestampParser, Configurable
}
/**
- * Implementation of the {@link Configurable Configurable} interface.
Configures this <code>FTPTimestampParser</code> according to the following
logic:
+ * Implements the {@link Configurable Configurable} interface. Configures
this <code>FTPTimestampParser</code> according to the following logic:
* <p>
* 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:
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 e0ec87ff..ab2a2e21 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
@@ -20,13 +20,15 @@ package org.apache.commons.net.ftp.parser;
import java.text.ParseException;
import java.util.List;
+import org.apache.commons.net.ftp.Configurable;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFile;
+import org.apache.commons.net.ftp.FTPFileEntryParser;
/**
- * Implementation of FTPFileEntryParser and FTPFileListParser for IBM zOS/MVS
Systems.
+ * Implements {@link FTPFileEntryParser} and {@link Configurable} for IBM
zOS/MVS Systems.
*
- * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for
usage instructions)
+ * @see FTPFileEntryParser Usage instructions.
*/
public class MVSFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
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 f6fd46dc..1097da82 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
@@ -23,11 +23,12 @@ import java.util.regex.Pattern;
import org.apache.commons.net.ftp.Configurable;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFile;
+import org.apache.commons.net.ftp.FTPFileEntryParser;
/**
- * Implementation of FTPFileEntryParser and FTPFileListParser for NT Systems.
+ * Implements {@link FTPFileEntryParser} and {@link Configurable} for NT
Systems.
*
- * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for
usage instructions)
+ * @see FTPFileEntryParser Usage instructions.
*/
public class NTFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
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 4b5a8822..635f9652 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
@@ -19,15 +19,17 @@ package org.apache.commons.net.ftp.parser;
import java.text.ParseException;
+import org.apache.commons.net.ftp.Configurable;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFile;
+import org.apache.commons.net.ftp.FTPFileEntryParser;
/**
- * Implementation of FTPFileEntryParser and FTPFileListParser for Netware
Systems. Note that some proprietary extensions for Novell-specific operations
+ * Implements {@link FTPFileEntryParser} and {@link Configurable} for Netware
Systems. Note that some proprietary extensions for Novell-specific operations
* are not supported. See <a
href="http://www.novell.com/documentation/nw65/index.html?page=/documentation/nw65/ftp_enu/data/fbhbgcfa.html";>
*
http://www.novell.com/documentation/nw65/index.html?page=/documentation/nw65/ftp_enu/data/fbhbgcfa.html</a>
for more details.
*
- * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for
usage instructions)
+ * @see FTPFileEntryParser Usage instructions.
* @since 1.5
*/
public class NetwareFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
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 4fec1423..5b2ad466 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
@@ -19,13 +19,15 @@ package org.apache.commons.net.ftp.parser;
import java.text.ParseException;
+import org.apache.commons.net.ftp.Configurable;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFile;
+import org.apache.commons.net.ftp.FTPFileEntryParser;
/**
- * Implementation of FTPFileEntryParser and FTPFileListParser for OS2 Systems.
+ * Implements of {@link FTPFileEntryParser} and {@link Configurable} for OS/2
Systems.
*
- * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for
usage instructions)
+ * @see FTPFileEntryParser Usage instructions.
*/
public class OS2FTPEntryParser extends ConfigurableFTPFileEntryParserImpl
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 2f8e33aa..71f93908 100644
--- a/src/main/java/org/apache/commons/net/imap/IMAP.java
+++ b/src/main/java/org/apache/commons/net/imap/IMAP.java
@@ -71,7 +71,7 @@ public class IMAP extends SocketClient {
/**
* <p>
- * Implementation of IMAPChunkListener that returns {@code true} but
otherwise does nothing.
+ * Implements {@link IMAPChunkListener} to returns {@code true} but
otherwise does nothing.
* </p>
* <p>
* This is intended for use with a suitable ProtocolCommandListener. If
the IMAP response contains multiple-line data, the protocol listener will be
called
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 c59310c0..51f04193 100644
--- a/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
+++ b/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
@@ -20,7 +20,7 @@ package org.apache.commons.net.ntp;
import java.net.DatagramPacket;
/**
- * Implementation of NtpV3Packet with methods converting Java objects to/from
the Network Time Protocol (NTP) data message header format described in
RFC-1305.
+ * Implements {@link NtpV3Packet} to convert Java objects to and from the
Network Time Protocol (NTP) data message header format described in RFC-1305.
*/
public class NtpV3Impl implements NtpV3Packet {
diff --git a/src/main/java/org/apache/commons/net/util/Base64.java
b/src/main/java/org/apache/commons/net/util/Base64.java
index c119196e..8ffad3e2 100644
--- a/src/main/java/org/apache/commons/net/util/Base64.java
+++ b/src/main/java/org/apache/commons/net/util/Base64.java
@@ -151,7 +151,6 @@ public class Base64 {
return new Base64().decode(base64String);
}
- // Implementation of integer encoding used for crypto
/**
* Decodes a byte64-encoded integer according to crypto standards such as
W3C's XML-Signature
*
