svn commit: r1529282 - in /httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http: client/HttpClient.java impl/client/HttpClientBuilder.java

[ol...@apache.org]

Author: olegk
Date: Fri Oct  4 20:30:25 2013
New Revision: 1529282

URL: http://svn.apache.org/r1529282
Log:
Javadoc tweaks

Modified:
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/HttpClientBuilder.java

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java?rev=1529282&r1=1529281&r2=1529282&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/HttpClient.java Fri Oct  4 20:30:25 2013
@@ -75,7 +75,7 @@ public interface HttpClient {
     ClientConnectionManager getConnectionManager();
 
     /**
-     * Executes a request using the default context.
+     * Executes HTTP request using the default context.
      *
      * @param request   the request to execute
      *
@@ -91,8 +91,7 @@ public interface HttpClient {
         throws IOException, ClientProtocolException;
 
     /**
-     * Executes a request using the given context.
-     * The route to the target will be determined by the HTTP client.
+     * Executes HTTP request using the given context.
      *
      * @param request   the request to execute
      * @param context   the context to use for the execution, or
@@ -110,7 +109,7 @@ public interface HttpClient {
         throws IOException, ClientProtocolException;
 
     /**
-     * Executes a request to the target using the default context.
+     * Executes HTTP request using the default context.
      *
      * @param target    the target host for the request.
      *                  Implementations may accept <code>null</code>
@@ -130,7 +129,7 @@ public interface HttpClient {
         throws IOException, ClientProtocolException;
 
     /**
-     * Executes a request to the target using the given context.
+     * Executes HTTP request using the given context.
      *
      * @param target    the target host for the request.
      *                  Implementations may accept <code>null</code>
@@ -153,7 +152,7 @@ public interface HttpClient {
         throws IOException, ClientProtocolException;
 
     /**
-     * Executes a request using the default context and processes the
+     * Executes HTTP request using the default context and processes the
      * response using the given response handler.
      * <p/>
      * Implementing classes are required to ensure that the content entity
@@ -175,7 +174,7 @@ public interface HttpClient {
         throws IOException, ClientProtocolException;
 
     /**
-     * Executes a request using the given context and processes the
+     * Executes HTTP request using the given context and processes the
      * response using the given response handler.
      * <p/>
      * Implementing classes are required to ensure that the content entity
@@ -200,7 +199,7 @@ public interface HttpClient {
         throws IOException, ClientProtocolException;
 
     /**
-     * Executes a request to the target using the default context and
+     * Executes HTTP request to the target using the default context and
      * processes the response using the given response handler.
      * <p/>
      * Implementing classes are required to ensure that the content entity
@@ -227,7 +226,7 @@ public interface HttpClient {
         throws IOException, ClientProtocolException;
 
     /**
-     * Executes a request to the target using the given context and
+     * Executes HTTP request to the target using the given context and
      * processes the response using the given response handler.
      * <p/>
      * Implementing classes are required to ensure that the content entity

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/HttpClientBuilder.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/HttpClientBuilder.java?rev=1529282&r1=1529281&r2=1529282&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/HttpClientBuilder.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/HttpClientBuilder.java Fri Oct  4 20:30:25 2013
@@ -534,8 +534,7 @@ public class HttpClientBuilder {
      * Assigns default proxy value.
      * <p/>
      * Please note this value can be overridden by the {@link #setRoutePlanner(
-     *   org.apache.http.conn.routing.HttpRoutePlanner)} and
-     * {@link #disableRedirectHandling()} methods.
+     *   org.apache.http.conn.routing.HttpRoutePlanner)} method.
      */
     public final HttpClientBuilder setProxy(final HttpHost proxy) {
         this.proxy = proxy;
@@ -544,9 +543,6 @@ public class HttpClientBuilder {
 
     /**
      * Assigns {@link HttpRoutePlanner} instance.
-     * <p/>
-     * Please note this value can be overridden by the {@link #disableRedirectHandling()}
-     * method.
      */
     public final HttpClientBuilder setRoutePlanner(final HttpRoutePlanner routePlanner) {
         this.routePlanner = routePlanner;
@@ -555,7 +551,10 @@ public class HttpClientBuilder {
 
     /**
      * Assigns {@link RedirectStrategy} instance.
-     */
+     * <p/>
+     * Please note this value can be overridden by the {@link #disableRedirectHandling()}
+     * method.
+`     */
     public final HttpClientBuilder setRedirectStrategy(final RedirectStrategy redirectStrategy) {
         this.redirectStrategy = redirectStrategy;
         return this;