JavaDoc fixes

git-svn-id: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpclient/trunk@541918 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Roland Weber 2007-05-26 16:37:38 +00:00
parent 65ccbdc833
commit cbdfa305f6
5 changed files with 17 additions and 18 deletions

View File

@ -146,7 +146,7 @@ public interface HttpClient {
* {@link #getContext default context}
*
* @return the response to the request. See
* {@link #execute(HttpHost,HttpRequest,HttpContext)
* {@link #execute(HttpUriRequest,HttpContext)
* execute(target,request,context)}
* for details.
*

View File

@ -168,7 +168,6 @@ public class HttpState {
* for the given scope.
*
* @see #getCredentials(AuthScope)
* @see #setProxyCredentials(AuthScope, Credentials)
*
* @since 3.0
*/

View File

@ -113,17 +113,18 @@ public class HttpClientParams {
public static final String PREEMPTIVE_AUTHENTICATION = "http.protocol.authentication-preemptive";
/**
* The key used to look up the list of IDs of supported {@link AuthScheme
* authentication schemes} in their order of preference. The scheme IDs are
* stored in a {@link java.util.Collection} as {@link java.lang.String}s.
* The key used to look up the list of IDs of supported
* {@link AuthPolicy authentication schemes} in their order of preference.
* The scheme IDs are stored in a {@link java.util.Collection} as
* instances of {@link java.lang.String}.
*
* <p>
* If several schemes are returned in the <tt>WWW-Authenticate</tt>
* or <tt>Proxy-Authenticate</tt> header, this parameter defines which
* {@link AuthScheme authentication schemes} takes precedence over others.
* {@link AuthPolicy authentication schemes} takes precedence over others.
* The first item in the collection represents the most preferred
* {@link AuthScheme authentication scheme}, the last item represents the ID
* of the least preferred one.
* {@link AuthPolicy authentication scheme}, the last item represents
* the ID of the least preferred one.
* </p>
*/
public static final String AUTH_SCHEME_PRIORITY = "http.protocol-auth-scheme-priority";

View File

@ -37,11 +37,9 @@ import org.apache.http.conn.HostConfiguration;
import org.apache.http.params.HttpParams;
/**
* This class represents a collection of HTTP protocol parameters applicable to
* {@link org.apache.http.conn.HttpConnectionManager HTTP connection managers}.
* Protocol parameters may be linked together to form a hierarchy. If a particular
* parameter value has not been explicitly defined in the collection itself, its
* value will be drawn from the parent collection of parameters.
* This class represents a collection of HTTP protocol parameters applicable
* to client-side
* {@link org.apache.http.conn.ClientConnectionManager connection managers}.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
* @author Michael Becke

View File

@ -368,11 +368,12 @@ public abstract class AbstractHttpClient
* execute(roureq, context)}.
* The route is computed by {@link #determineRoute determineRoute}.
*
* @param target the target host for the request.
* Some implementations may accept <code>null</code>.
* @param request the request to execute
* @param context the request-specific execution context,
* or <code>null</code> to use a default context
*/
public final HttpResponse execute(HttpUriRequest request, HttpContext context)
public final HttpResponse execute(HttpUriRequest request,
HttpContext context)
throws HttpException, IOException {
if (request == null) {
@ -457,8 +458,8 @@ public abstract class AbstractHttpClient
/**
* Determines the route for a request.
* Called by {@link #execute(HttpHost,HttpRequest,HttpContext)
* execute(target, request, context)}
* Called by {@link #execute(HttpUriRequest,HttpContext)
* execute(urirequest, context)}
* to map to {@link HttpClient#execute(RoutedRequest,HttpContext)
* execute(roureq, context)}.
*