Author: sebb
Date: Fri Feb 27 01:57:19 2009
New Revision: 748376
URL: http://svn.apache.org/viewvc?rev=748376&view=rev
Log:
Javadoc corrections
Modified:
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/SocketClient.java
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
Modified:
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/SocketClient.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/SocketClient.java?rev=748376&r1=748375&r2=748376&view=diff
==============================================================================
---
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/SocketClient.java
(original)
+++
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/SocketClient.java
Fri Feb 27 01:57:19 2009
@@ -573,7 +573,7 @@
/**
* Get the underlying socket connection timeout.
- * @return
+ * @return timeout (in ms)
* @since 2.0
*/
public int getConnectTimeout() {
Modified:
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/bsd/RCommandClient.java?rev=748376&r1=748375&r2=748376&view=diff
==============================================================================
---
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
(original)
+++
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
Fri Feb 27 01:57:19 2009
@@ -24,6 +24,7 @@
import java.net.ServerSocket;
import java.net.Socket;
import java.net.SocketException;
+import java.net.UnknownHostException;
import org.apache.commons.net.io.SocketInputStream;
@@ -251,7 +252,7 @@
***/
@Override
public void connect(String hostname, int port)
- throws SocketException, IOException
+ throws SocketException, IOException, UnknownHostException
{
connect(InetAddress.getByName(hostname), port,
InetAddress.getLocalHost());
}
@@ -335,7 +336,7 @@
@Override
public void connect(String hostname, int port,
InetAddress localAddr, int localPort)
- throws SocketException, IOException, IllegalArgumentException
+ throws SocketException, IOException, IllegalArgumentException,
UnknownHostException
{
if (localPort < MIN_CLIENT_PORT || localPort > MAX_CLIENT_PORT)
throw new IllegalArgumentException("Invalid port number " +
localPort);
Modified:
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java?rev=748376&r1=748375&r2=748376&view=diff
==============================================================================
---
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
(original)
+++
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
Fri Feb 27 01:57:19 2009
@@ -94,7 +94,7 @@
* @author <a href="mailto:[email protected]";>Steve Cohen</a>
* @version $Id$
* @see org.apache.commons.net.ftp.FTPFile
- * @see org.apache.commons.net.ftp.FTPClient#createFileList
+ * @see org.apache.commons.net.ftp.FTPClient#listFiles()
*/
public interface FTPFileEntryParser
{
Modified:
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java?rev=748376&r1=748375&r2=748376&view=diff
==============================================================================
---
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
(original)
+++
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
Fri Feb 27 01:57:19 2009
@@ -139,7 +139,7 @@
* Alter the current regular expression being utilised for entry parsing
* and create a new {...@link Pattern} instance.
* @param regex The new regular expression
- * @return
+ * @return true if the compiled pattern is not null
* @since 2.0
*/
public boolean setRegex(String regex) {
Modified:
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/telnet/TelnetClient.java?rev=748376&r1=748375&r2=748376&view=diff
==============================================================================
---
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
(original)
+++
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/telnet/TelnetClient.java
Fri Feb 27 01:57:19 2009
@@ -192,13 +192,13 @@
/***
* Sends an Are You There sequence and waits for the result.
* <p>
- * @throws InterruptedException
- * @throws IllegalArgumentException
- * @throws IOException
- * <p>
* @param timeout - Time to wait for a response (millis.)
* <p>
* @return true if AYT received a response, false otherwise
+ * <p>
+ * @throws InterruptedException
+ * @throws IllegalArgumentException
+ * @throws IOException
***/
public boolean sendAYT(long timeout)
throws IOException, IllegalArgumentException, InterruptedException
