Javadoc tweaks

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1529282 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Oleg Kalnichevski 2013-10-04 20:30:25 +00:00
parent 3e4455035e
commit cb89108e45
2 changed files with 13 additions and 15 deletions

View File

@ -75,7 +75,7 @@ public interface HttpClient {
ClientConnectionManager getConnectionManager(); ClientConnectionManager getConnectionManager();
/** /**
* Executes a request using the default context. * Executes HTTP request using the default context.
* *
* @param request the request to execute * @param request the request to execute
* *
@ -91,8 +91,7 @@ public interface HttpClient {
throws IOException, ClientProtocolException; throws IOException, ClientProtocolException;
/** /**
* Executes a request using the given context. * Executes HTTP request using the given context.
* The route to the target will be determined by the HTTP client.
* *
* @param request the request to execute * @param request the request to execute
* @param context the context to use for the execution, or * @param context the context to use for the execution, or
@ -110,7 +109,7 @@ public interface HttpClient {
throws IOException, ClientProtocolException; 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. * @param target the target host for the request.
* Implementations may accept <code>null</code> * Implementations may accept <code>null</code>
@ -130,7 +129,7 @@ public interface HttpClient {
throws IOException, ClientProtocolException; 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. * @param target the target host for the request.
* Implementations may accept <code>null</code> * Implementations may accept <code>null</code>
@ -153,7 +152,7 @@ public interface HttpClient {
throws IOException, ClientProtocolException; 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. * response using the given response handler.
* <p/> * <p/>
* Implementing classes are required to ensure that the content entity * Implementing classes are required to ensure that the content entity
@ -175,7 +174,7 @@ public interface HttpClient {
throws IOException, ClientProtocolException; 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. * response using the given response handler.
* <p/> * <p/>
* Implementing classes are required to ensure that the content entity * Implementing classes are required to ensure that the content entity
@ -200,7 +199,7 @@ public interface HttpClient {
throws IOException, ClientProtocolException; 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. * processes the response using the given response handler.
* <p/> * <p/>
* Implementing classes are required to ensure that the content entity * Implementing classes are required to ensure that the content entity
@ -227,7 +226,7 @@ public interface HttpClient {
throws IOException, ClientProtocolException; 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. * processes the response using the given response handler.
* <p/> * <p/>
* Implementing classes are required to ensure that the content entity * Implementing classes are required to ensure that the content entity

View File

@ -534,8 +534,7 @@ public class HttpClientBuilder {
* Assigns default proxy value. * Assigns default proxy value.
* <p/> * <p/>
* Please note this value can be overridden by the {@link #setRoutePlanner( * Please note this value can be overridden by the {@link #setRoutePlanner(
* org.apache.http.conn.routing.HttpRoutePlanner)} and * org.apache.http.conn.routing.HttpRoutePlanner)} method.
* {@link #disableRedirectHandling()} methods.
*/ */
public final HttpClientBuilder setProxy(final HttpHost proxy) { public final HttpClientBuilder setProxy(final HttpHost proxy) {
this.proxy = proxy; this.proxy = proxy;
@ -544,9 +543,6 @@ public class HttpClientBuilder {
/** /**
* Assigns {@link HttpRoutePlanner} instance. * Assigns {@link HttpRoutePlanner} instance.
* <p/>
* Please note this value can be overridden by the {@link #disableRedirectHandling()}
* method.
*/ */
public final HttpClientBuilder setRoutePlanner(final HttpRoutePlanner routePlanner) { public final HttpClientBuilder setRoutePlanner(final HttpRoutePlanner routePlanner) {
this.routePlanner = routePlanner; this.routePlanner = routePlanner;
@ -555,7 +551,10 @@ public class HttpClientBuilder {
/** /**
* Assigns {@link RedirectStrategy} instance. * Assigns {@link RedirectStrategy} instance.
*/ * <p/>
* Please note this value can be overridden by the {@link #disableRedirectHandling()}
* method.
` */
public final HttpClientBuilder setRedirectStrategy(final RedirectStrategy redirectStrategy) { public final HttpClientBuilder setRedirectStrategy(final RedirectStrategy redirectStrategy) {
this.redirectStrategy = redirectStrategy; this.redirectStrategy = redirectStrategy;
return this; return this;