svn commit: r1333369 - /commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java

[se...@apache.org]

Author: sebb
Date: Thu May  3 09:06:14 2012
New Revision: 1333369

URL: http://svn.apache.org/viewvc?rev=1333369&view=rev
Log:
Javadoc

Modified:
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java?rev=1333369&r1=1333368&r2=1333369&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java Thu May  3 09:06:14 2012
@@ -837,10 +837,12 @@ implements Configurable
     /***
      * Sets the timeout in milliseconds to use when reading from the
      * data connection.  This timeout will be set immediately after
-     * opening the data connection.
+     * opening the data connection, provided that the value is ≥ 0.
      * <p>
+     * <b>Note:</b> the timeout will also be applied when calling accept()
+     * whilst establishing an active local data connection.
      * @param  timeout The default timeout in milliseconds that is used when
-     *        opening a data connection socket.
+     *        opening a data connection socket. The value 0 means an infinite timeout.
      ***/
     public void setDataTimeout(int timeout)
     {