sebbASF commented on code in PR #141:
URL: https://github.com/apache/commons-net/pull/141#discussion_r1080653735
##########
src/main/java/org/apache/commons/net/ftp/FTPSClient.java:
##########
@@ -375,7 +375,7 @@ public int execADAT(final byte[] data) throws IOException {
/**
* AUTH command.
*
- * @throws SSLException If it server reply code not equal "234" and "334".
+ * @throws SSLException If the server reply code ss equal to neither "234"
nor "334".
Review Comment:
Does not read well; and what is 'ss' ?
Might be better to put:
If the server reply code equals neither "234" nor "334".
##########
src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java:
##########
@@ -57,7 +57,7 @@ public class VMSFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* Constructor for a VMSFTPEntryParser object.
*
- * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. It it is seen, this is
a
+ * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. If it is seen, this is
a
Review Comment:
This should agree with the wording above
##########
src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java:
##########
@@ -68,7 +68,7 @@ public VMSFTPEntryParser() {
* This constructor allows the creation of a VMSFTPEntryParser object with
something other than the default configuration.
*
* @param config The {@link FTPClientConfig configuration} object used to
configure this parser.
- * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. It it is seen, this is
a
+ * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. If it is seen, this is
a
Review Comment:
Ditto
##########
src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java:
##########
@@ -437,8 +437,8 @@ private FTPFile parseMemberList(final String entry) {
}
/**
- * preParse is called as part of the interface. Per definition is is
called before the parsing takes place. Three kind of lists is recognize:
z/OS-MVS File
- * lists z/OS-MVS Member lists unix file lists
+ * preParse is called as part of the interface. Per definition, it is
called before the parsing takes place. Three kinds of lists are recognized:
+ * z/OS-MVS File lists z/OS-MVS Member lists unix file lists
Review Comment:
Need some delimiters - e.g. commas - to show the lists clearly.
Better would be to use a list.
##########
src/main/java/org/apache/commons/net/imap/IMAPReply.java:
##########
@@ -74,7 +74,7 @@ public final class IMAPReply {
private static final Pattern LITERAL_PATTERN =
Pattern.compile("\\{(\\d+)\\}$"); // {dd}
/**
- * Intepret the String reply code - OK, NO, BAD - in a tagged response as
a integer.
+ * Intepret the String reply code - OK, NO, BAD - in a tagged response as
an integer.
Review Comment:
interpret
##########
src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java:
##########
@@ -61,7 +61,7 @@ public VMSVersioningFTPEntryParser() {
* This constructor allows the creation of a VMSVersioningFTPEntryParser
object with something other than the default configuration.
*
* @param config The {@link FTPClientConfig configuration} object used to
configure this parser.
- * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. It it is seen, this is
a
+ * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. If it is seen, this is
a
Review Comment:
Ditto
##########
src/main/java/org/apache/commons/net/telnet/Telnet.java:
##########
@@ -980,7 +980,7 @@ boolean stateIsDo(final int option) {
/**
* Looks for the state of the option.
*
- * @return returns true if a dont has been acknowledged
+ * @return returns true if a {@code dont} has been acknowledged
Review Comment:
DONT
##########
src/main/java/org/apache/commons/net/telnet/Telnet.java:
##########
@@ -633,7 +633,7 @@ final synchronized void requestDont(final int option)
throws IOException {
/**
* Looks for the state of the option.
*
- * @return returns true if a do has been reuqested
+ * @return returns true if a {@code do} has been requested.
Review Comment:
do => DO
##########
src/main/java/org/apache/commons/net/telnet/Telnet.java:
##########
@@ -969,7 +969,7 @@ void spyWrite(final int ch) {
/**
* Looks for the state of the option.
*
- * @return returns true if a do has been acknowledged
+ * @return returns true if a {@code do} has been acknowledged.
Review Comment:
DO
##########
src/main/java/org/apache/commons/net/telnet/Telnet.java:
##########
@@ -666,7 +666,7 @@ boolean requestedWill(final int option) {
/**
* Looks for the state of the option.
*
- * @return returns true if a wont has been reuqested
+ * @return returns true if a won't has been requested
Review Comment:
won't => WONT
##########
src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java:
##########
@@ -110,7 +110,7 @@ public class UnixFTPEntryParser extends
ConfigurableFTPFileEntryParserImpl {
/**
* The default constructor for a UnixFTPEntryParser object.
*
- * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. It it is seen, this is
a
+ * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. If it is seen, this is
a
Review Comment:
In which case I suggest:
"Should not be thrown ... If it is thrown"
##########
src/main/java/org/apache/commons/net/ftp/parser/VMSVersioningFTPEntryParser.java:
##########
@@ -50,7 +50,7 @@ public class VMSVersioningFTPEntryParser extends
VMSFTPEntryParser {
/**
* Constructor for a VMSFTPEntryParser object.
*
- * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. It it is seen, this is
a
+ * @throws IllegalArgumentException Thrown if the regular expression is
unparseable. Should not be seen under normal conditions. If it is seen, this is
a
Review Comment:
Dittto
##########
src/main/java/org/apache/commons/net/imap/IMAPReply.java:
##########
@@ -106,7 +106,7 @@ private static int getReplyCode(final String line, final
Pattern pattern) throws
}
/**
- * Intepret the String reply code - OK, NO, BAD - in an untagged response
as a integer.
+ * Intepret the String reply code - OK, NO, BAD - in an untagged response
as an integer.
Review Comment:
Interpret
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
