You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2014/04/13 15:43:34 UTC
svn commit: r1586983 - in /commons/proper/net/trunk/src/main/java: examples/
org/apache/commons/net/ntp/ org/apache/commons/net/pop3/
org/apache/commons/net/telnet/
Author: sebb
Date: Sun Apr 13 13:43:33 2014
New Revision: 1586983
URL: http://svn.apache.org/r1586983
Log:
Java 8 Javadoc fixes
Modified:
commons/proper/net/trunk/src/main/java/examples/Main.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
Modified: commons/proper/net/trunk/src/main/java/examples/Main.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/examples/Main.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/examples/Main.java (original)
+++ commons/proper/net/trunk/src/main/java/examples/Main.java Sun Apr 13 13:43:33 2014
@@ -31,7 +31,7 @@ public class Main {
/**
* Helper application for example classes.
* Lists available classes, and provides shorthand invocation.
- * For example:<br/>
+ * For example:<br>
* <code>java -jar commons-net-examples-m.n.jar FTPClientExample -l host user password</code>
*
* @param args the first argument is used to name the class; remaining arguments
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java Sun Apr 13 13:43:33 2014
@@ -46,12 +46,12 @@ public class TimeStamp implements java.i
private static final long serialVersionUID = 8139806907588338737L;
/**
- * baseline NTP time if bit-0=0 -> 7-Feb-2036 @ 06:28:16 UTC
+ * baseline NTP time if bit-0=0 is 7-Feb-2036 @ 06:28:16 UTC
*/
protected static final long msb0baseTime = 2085978496000L;
/**
- * baseline NTP time if bit-0=1 -> 1-Jan-1900 @ 01:00:00 UTC
+ * baseline NTP time if bit-0=1 is 1-Jan-1900 @ 01:00:00 UTC
*/
protected static final long msb1baseTime = -2208988800000L;
@@ -308,7 +308,7 @@ public class TimeStamp implements java.i
* represented by this <code>TimeStamp</code> object. That is, the hashcode
* is the value of the expression:
* <blockquote><pre>
- * (int)(this.ntpValue()^(this.ntpValue() >>> 32))
+ * {@code (int)(this.ntpValue()^(this.ntpValue() >>> 32))}
* </pre></blockquote>
*
* @return a hash code value for this object.
@@ -342,7 +342,7 @@ public class TimeStamp implements java.i
* 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
+ * 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.
@@ -372,7 +372,7 @@ public class TimeStamp implements java.i
* 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
+ * 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.
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java Sun Apr 13 13:43:33 2014
@@ -554,7 +554,7 @@ public class POP3Client extends POP3
* properly.
* <p>
* @param messageId The number of the message to fetch.
- * @param numLines The top number of lines to fetch. This must be >= 0.
+ * @param numLines The top number of lines to fetch. This must be >= 0.
* @return A DotTerminatedMessageReader instance
* from which the specified top number of lines of the message can be
* read.
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/EchoOptionHandler.java Sun Apr 13 13:43:33 2014
@@ -54,7 +54,7 @@ public class EchoOptionHandler extends T
/***
* Implements the abstract method of TelnetOptionHandler.
* <p>
- * @param suboptionData - the sequence received, whithout IAC SB & IAC SE
+ * @param suboptionData - the sequence received, without IAC SB & IAC SE
* @param suboptionLength - the length of data in suboption_data
* <p>
* @return always null (no response to subnegotiation)
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SimpleOptionHandler.java Sun Apr 13 13:43:33 2014
@@ -61,7 +61,7 @@ public class SimpleOptionHandler extends
/***
* Implements the abstract method of TelnetOptionHandler.
* <p>
- * @param suboptionData - the sequence received, whithout IAC SB & IAC SE
+ * @param suboptionData - the sequence received, without IAC SB & IAC SE
* @param suboptionLength - the length of data in suboption_data
* <p>
* @return always null (no response to subnegotiation)
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/SuppressGAOptionHandler.java Sun Apr 13 13:43:33 2014
@@ -54,7 +54,7 @@ public class SuppressGAOptionHandler ext
/***
* Implements the abstract method of TelnetOptionHandler.
* <p>
- * @param suboptionData - the sequence received, whithout IAC SB & IAC SE
+ * @param suboptionData - the sequence received, without IAC SB & IAC SE
* @param suboptionLength - the length of data in suboption_data
* <p>
* @return always null (no response to subnegotiation)
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetOptionHandler.java Sun Apr 13 13:43:33 2014
@@ -194,11 +194,11 @@ public abstract class TelnetOptionHandle
* Must be implemented by the actual TelnetOptionHandler to specify
* which response must be sent for the subnegotiation request.
* <p>
- * @param suboptionData - the sequence received, whithout IAC SB & IAC SE
+ * @param suboptionData - the sequence received, without IAC SB & IAC SE
* @param suboptionLength - the length of data in suboption_data
* <p>
* @return response to be sent to the subnegotiation sequence. TelnetClient
- * will add IAC SB & IAC SE. null means no response
+ * will add IAC SB & IAC SE. null means no response
***/
public abstract int[] answerSubnegotiation(int suboptionData[],
int suboptionLength);
@@ -210,7 +210,7 @@ public abstract class TelnetOptionHandle
* sent by TelnetClient when the option is activated.
* <p>
* @return subnegotiation sequence to be sent by TelnetClient. TelnetClient
- * will add IAC SB & IAC SE. null means no subnegotiation.
+ * will add IAC SB & IAC SE. null means no subnegotiation.
***/
public abstract int[] startSubnegotiationLocal();
@@ -221,7 +221,7 @@ public abstract class TelnetOptionHandle
* sent by TelnetClient when the option is activated.
* <p>
* @return subnegotiation sequence to be sent by TelnetClient. TelnetClient
- * will add IAC SB & IAC SE. null means no subnegotiation.
+ * will add IAC SB & IAC SE. null means no subnegotiation.
***/
public abstract int[] startSubnegotiationRemote();
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TerminalTypeOptionHandler.java Sun Apr 13 13:43:33 2014
@@ -82,7 +82,7 @@ public class TerminalTypeOptionHandler e
/***
* Implements the abstract method of TelnetOptionHandler.
* <p>
- * @param suboptionData - the sequence received, whithout IAC SB & IAC SE
+ * @param suboptionData - the sequence received, without IAC SB & IAC SE
* @param suboptionLength - the length of data in suboption_data
* <p>
* @return terminal type information
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java?rev=1586983&r1=1586982&r2=1586983&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/WindowSizeOptionHandler.java Sun Apr 13 13:43:33 2014
@@ -100,7 +100,7 @@ public class WindowSizeOptionHandler ext
/***
* Implements the abstract method of TelnetOptionHandler.
* <p>
- * @param suboptionData - the sequence received, whithout IAC SB & IAC SE
+ * @param suboptionData - the sequence received, without IAC SB & IAC SE
* @param suboptionLength - the length of data in suboption_data
* <p>
* @return terminal type information