From 36c082fdfc86c691024bdedfbc0716cfc6512342 Mon Sep 17 00:00:00 2001 From: Roland Weber Date: Wed, 3 Jan 2007 15:36:59 +0000 Subject: [PATCH] JavaDoc fixes git-svn-id: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpclient/trunk@492183 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/http/auth/AuthScheme.java | 4 ++-- .../http/conn/impl/IdleConnectionHandler.java | 6 +++--- .../impl/MultiThreadedHttpConnectionManager.java | 7 +++---- .../http/conn/impl/SimpleHttpConnectionManager.java | 4 +--- .../conn/params/HttpConnectionManagerParams.java | 2 +- .../apache/http/cookie/CookieAttributeHandler.java | 8 ++++---- src/java/org/apache/http/cookie/CookieSpec.java | 2 +- .../apache/http/cookie/params/CookieSpecParams.java | 13 ++++++------- 8 files changed, 21 insertions(+), 25 deletions(-) diff --git a/src/java/org/apache/http/auth/AuthScheme.java b/src/java/org/apache/http/auth/AuthScheme.java index 520660818..d1e0637e9 100644 --- a/src/java/org/apache/http/auth/AuthScheme.java +++ b/src/java/org/apache/http/auth/AuthScheme.java @@ -75,7 +75,7 @@ public interface AuthScheme { * may involve multiple challenge-response exchanges. Such schemes must be able * to maintain the state information when dealing with sequential challenges * - * @param challenge the challenge string + * @param header the challenge header * * @since 3.0 */ @@ -134,7 +134,7 @@ public interface AuthScheme { * Produces an authorization string for the given set of {@link Credentials}. * * @param credentials The set of credentials to be used for athentication - * @param method The method being authenticated + * @param message The request being authenticated * @throws AuthenticationException if authorization string cannot * be generated due to an authentication failure * diff --git a/src/java/org/apache/http/conn/impl/IdleConnectionHandler.java b/src/java/org/apache/http/conn/impl/IdleConnectionHandler.java index 654453cb9..ecccdda09 100644 --- a/src/java/org/apache/http/conn/impl/IdleConnectionHandler.java +++ b/src/java/org/apache/http/conn/impl/IdleConnectionHandler.java @@ -43,7 +43,7 @@ import org.apache.http.conn.HttpHostConnection; * *

This class is not synchronized.

* - * @see org.apache.commons.httpclient.HttpConnectionManager#closeIdleConnections(long) + * @see org.apache.http.conn.HttpConnectionManager#closeIdleConnections(long) * * @since 3.0 */ @@ -63,11 +63,11 @@ public class IdleConnectionHandler { /** * Registers the given connection with this handler. The connection will be held until - * {@link #remove(HttpConnection)} or {@link #closeIdleConnections(long)} is called. + * {@link #remove} or {@link #closeIdleConnections} is called. * * @param connection the connection to add * - * @see #remove(HttpConnection) + * @see #remove */ public void add(HttpHostConnection connection) { diff --git a/src/java/org/apache/http/conn/impl/MultiThreadedHttpConnectionManager.java b/src/java/org/apache/http/conn/impl/MultiThreadedHttpConnectionManager.java index a9c3eca6e..f47624a41 100644 --- a/src/java/org/apache/http/conn/impl/MultiThreadedHttpConnectionManager.java +++ b/src/java/org/apache/http/conn/impl/MultiThreadedHttpConnectionManager.java @@ -430,8 +430,7 @@ public class MultiThreadedHttpConnectionManager implements HttpConnectionManager * Gets the total number of pooled connections for the given host configuration. This * is the total number of connections that have been created and are still in use * by this connection manager for the host configuration. This value will - * not exceed the {@link #getMaxConnectionsPerHost() maximum number of connections per - * host}. + * not exceed the maximum number of connections per host. * * @param hostConfiguration The host configuration * @return The total number of pooled connections @@ -446,8 +445,8 @@ public class MultiThreadedHttpConnectionManager implements HttpConnectionManager /** * Gets the total number of pooled connections. This is the total number of * connections that have been created and are still in use by this connection - * manager. This value will not exceed the {@link #getMaxTotalConnections() - * maximum number of connections}. + * manager. This value will not exceed the maximum number of connections + * in total. * * @return the total number of pooled connections */ diff --git a/src/java/org/apache/http/conn/impl/SimpleHttpConnectionManager.java b/src/java/org/apache/http/conn/impl/SimpleHttpConnectionManager.java index 978aae143..d2b3ee0e4 100644 --- a/src/java/org/apache/http/conn/impl/SimpleHttpConnectionManager.java +++ b/src/java/org/apache/http/conn/impl/SimpleHttpConnectionManager.java @@ -184,9 +184,7 @@ public class SimpleHttpConnectionManager implements HttpConnectionManager { return httpConnection; } - /** - * @see HttpConnectionManager#releaseConnection(org.apache.commons.httpclient.HttpConnection) - */ + // non-javadoc, see interface HttpConnectionManager public void releaseConnection(HttpHostConnection conn) { if (conn != httpConnection) { throw new IllegalStateException("Unexpected release of an unknown connection."); diff --git a/src/java/org/apache/http/conn/params/HttpConnectionManagerParams.java b/src/java/org/apache/http/conn/params/HttpConnectionManagerParams.java index 147088617..8984f381a 100644 --- a/src/java/org/apache/http/conn/params/HttpConnectionManagerParams.java +++ b/src/java/org/apache/http/conn/params/HttpConnectionManagerParams.java @@ -38,7 +38,7 @@ import org.apache.http.params.HttpParams; /** * This class represents a collection of HTTP protocol parameters applicable to - * {@link HttpConnectionManager HTTP connection managers}. + * {@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. diff --git a/src/java/org/apache/http/cookie/CookieAttributeHandler.java b/src/java/org/apache/http/cookie/CookieAttributeHandler.java index 7721c681a..e0d72cd25 100644 --- a/src/java/org/apache/http/cookie/CookieAttributeHandler.java +++ b/src/java/org/apache/http/cookie/CookieAttributeHandler.java @@ -47,9 +47,9 @@ public interface CookieAttributeHandler { /** * Parse the given cookie attribute value and update the corresponding - * {@link org.apache.commons.httpclient.Cookie} property. + * {@link org.apache.http.cookie.Cookie} property. * - * @param cookie {@link org.apache.commons.httpclient.Cookie} to be updated + * @param cookie {@link org.apache.http.cookie.Cookie} to be updated * @param value cookie attribute value from the cookie response header */ void parse(Cookie cookie, String value) @@ -58,7 +58,7 @@ public interface CookieAttributeHandler { /** * Peforms cookie validation for the given attribute value. * - * @param cookie {@link org.apache.commons.httpclient.Cookie} to validate + * @param cookie {@link org.apache.http.cookie.Cookie} to validate * @param origin the cookie source to validate against * @throws MalformedCookieException if cookie validation fails for this attribute */ @@ -69,7 +69,7 @@ public interface CookieAttributeHandler { * Matches the given value (property of the destination host where request is being * submitted) with the corresponding cookie attribute. * - * @param cookie {@link org.apache.commons.httpclient.Cookie} to match + * @param cookie {@link org.apache.http.cookie.Cookie} to match * @param origin the cookie source to match against * @return true if the match is successful; false otherwise */ diff --git a/src/java/org/apache/http/cookie/CookieSpec.java b/src/java/org/apache/http/cookie/CookieSpec.java index 999b2c2db..e6e73c18e 100644 --- a/src/java/org/apache/http/cookie/CookieSpec.java +++ b/src/java/org/apache/http/cookie/CookieSpec.java @@ -56,7 +56,7 @@ public interface CookieSpec { *

This method will not perform the validation of the resultant * {@link Cookie}s

* - * @see #validate(String, int, String, boolean, Cookie) + * @see #validate * * @param header the Set-Cookie received from the server * @param origin details of the cookie origin diff --git a/src/java/org/apache/http/cookie/params/CookieSpecParams.java b/src/java/org/apache/http/cookie/params/CookieSpecParams.java index 4e0cc69bf..f3b19cb04 100644 --- a/src/java/org/apache/http/cookie/params/CookieSpecParams.java +++ b/src/java/org/apache/http/cookie/params/CookieSpecParams.java @@ -56,8 +56,8 @@ public final class CookieSpecParams { public static final String DATE_PATTERNS = "http.protocol.cookie-datepatterns"; /** - * Defines whether {@link org.apache.commons.httpclient.Cookie cookies} should be put on - * a single {@link org.apache.commons.httpclient.Header response header}. + * Defines whether {@link org.apache.http.cookie.Cookie cookies} should be put on + * a single {@link org.apache.http.Header request header}. *

* This parameter expects a value of type {@link Boolean}. *

@@ -65,7 +65,7 @@ public final class CookieSpecParams { public static final String SINGLE_COOKIE_HEADER = "http.protocol.single-cookie-header"; /** - * Defines {@link CookieSpec cookie specification} to be used for cookie management. + * Defines {@link org.apache.http.cookie.CookieSpec cookie specification} to be used for cookie management. *

* This parameter expects a value of type {@link String}. *

@@ -105,11 +105,10 @@ public final class CookieSpecParams { } /** - * Assigns the {@link CookiePolicy cookie policy} to be used by the - * {@link org.apache.commons.httpclient.HttpMethod HTTP methods} - * this collection of parameters applies to. + * Assigns the {@link org.apache.http.cookie.CookiePolicy cookie policy} to be used + * when executing a request based on these parameters. * - * @param policy the {@link CookiePolicy cookie policy} + * @param policy the cookie policy */ public static void setCookiePolicy(final HttpParams params, String policy) { if (params == null) {