svn commit: r1099906 - /httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java

[se...@apache.org]

Author: sebb
Date: Thu May  5 18:25:31 2011
New Revision: 1099906

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

Modified:
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java?rev=1099906&r1=1099905&r2=1099906&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java Thu May  5 18:25:31 2011
@@ -95,6 +95,8 @@ public class HttpClientParams {
     }
 
     /**
+     * Set the parameter {@code ClientPNames.CONN_MANAGER_TIMEOUT}.
+     * 
      * @since 4.2
      */
     public static void setConnectionManagerTimeout(final HttpParams params, long timeout) {
@@ -105,7 +107,13 @@ public class HttpClientParams {
     }
 
     /**
+     * Get the connectiion manager timeout value.
+     * This is defined by the parameter {@code ClientPNames.CONN_MANAGER_TIMEOUT}. 
+     * Failing that it uses the parameter {@code CoreConnectionPNames.CONNECTION_TIMEOUT} 
+     * which defaults to 0 if not defined.
+     * 
      * @since 4.2
+     * @return the timeout value
      */
     public static long getConnectionManagerTimeout(final HttpParams params) {
         if (params == null) {