Merge pull request AsyncHttpClient#756 from magro/master

Stephane Landelle · Stephane Landelle · commit cdf70a5f102c · 2014-11-08T21:32:15.000+01:00
Adjust javadoc for requestTimeout to clarify its meaning.
diff --git a/api/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java b/api/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java
@@ -248,9 +248,9 @@ public int getPooledConnectionIdleTimeout() {
     }
 
     /**
-     * Return the maximum time in millisecond an {@link AsyncHttpClient} wait for a response
+     * Return the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.
      *
-     * @return the maximum time in millisecond an {@link AsyncHttpClient} wait for a response
+     * @return the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.
      */
     public int getRequestTimeout() {
         return requestTimeout;
@@ -664,9 +664,9 @@ public Builder setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout) {
         }
 
         /**
-         * Set the maximum time in millisecond an {@link AsyncHttpClient} wait for a response
+         * Set the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.
          *
-         * @param requestTimeout the maximum time in millisecond an {@link AsyncHttpClient} wait for a response
+         * @param requestTimeout the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.
          * @return a {@link Builder}
          */
         public Builder setRequestTimeout(int requestTimeout) {

Original file line number	Diff line number	Diff line change
`@@ -248,9 +248,9 @@ public int getPooledConnectionIdleTimeout() {`
`248`	`248`	`}`
`249`	`249`
`250`	`250`	`/**`
`251`		`- * Return the maximum time in millisecond an {@link AsyncHttpClient} wait for a response`
	`251`	`+ * Return the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.`
`252`	`252`	`*`
`253`		`- * @return the maximum time in millisecond an {@link AsyncHttpClient} wait for a response`
	`253`	`+ * @return the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.`
`254`	`254`	`*/`
`255`	`255`	`public int getRequestTimeout() {`
`256`	`256`	`return requestTimeout;`
`@@ -664,9 +664,9 @@ public Builder setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout) {`
`664`	`664`	`}`
`665`	`665`
`666`	`666`	`/**`
`667`		`- * Set the maximum time in millisecond an {@link AsyncHttpClient} wait for a response`
	`667`	`+ * Set the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.`
`668`	`668`	`*`
`669`		`- * @param requestTimeout the maximum time in millisecond an {@link AsyncHttpClient} wait for a response`
	`669`	`+ * @param requestTimeout the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.`
`670`	`670`	`* @return a {@link Builder}`
`671`	`671`	`*/`
`672`	`672`	`public Builder setRequestTimeout(int requestTimeout) {`