JavaDoc fixes in client/cookie/auth

git-svn-id: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpclient/trunk@531154 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/http/auth/AuthSchemeRegistry.java

@@ -55,7 +55,7 @@ public final class AuthSchemeRegistry {
     /**
      * Registers a {@link AuthSchemeFactory} with  the given identifier. If a factory with the 
      * given name already exists it will be overridden. This name is the same one used to 
-     * retrieve the {@link AuthScheme authentication scheme} from {@link #getAuthScheme(String)}.
+     * retrieve the {@link AuthScheme authentication scheme} from {@link #getAuthScheme}.
      * 
      * <p>
      * Please note that custom authentication preferences, if used, need to be updated accordingly 
@@ -65,7 +65,7 @@ public final class AuthSchemeRegistry {
      * @param name the identifier for this scheme
      * @param factory the {@link AuthSchemeFactory} class to register
      * 
-     * @see #getAuthScheme(String)
+     * @see #getAuthScheme
      */
     public synchronized void registerAuthScheme(
             final String name, 

src/java/org/apache/http/auth/AuthScope.java

@@ -35,7 +35,7 @@ import org.apache.http.util.LangUtils;
 /** 
  * The class represents an authentication scope consisting of a host name,
  * a port number, a realm name and an authentication scheme name which 
- * {@link org.apache.commons.httpclient.Credentials} apply to.
+ * {@link Credentials Credentials} apply to.
  * 
  * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
  * @author <a href="mailto:adrian@intencha.com">Adrian Sutton</a>

src/java/org/apache/http/auth/UsernamePasswordCredentials.java

@@ -104,7 +104,6 @@ public class UsernamePasswordCredentials implements Credentials {
      * User name property getter.
      *
      * @return the userName
-     * @see #setUserName(String)
      */
     public String getPrincipalName() {
         return userName;
@@ -115,7 +114,6 @@ public class UsernamePasswordCredentials implements Credentials {
      * Password property getter.
      *
      * @return the password
-     * @see #setPassword(String)
      */
     public String getPassword() {
         return password;

src/java/org/apache/http/auth/params/AuthParams.java

@@ -48,8 +48,11 @@ public final class AuthParams {
 
     /**
      * Defines the charset to be used when encoding 
-     * {@link org.apache.http.auth.Credentials}. If not defined then the 
+     * {@link org.apache.http.auth.Credentials}.
-     * {@link #HTTP_ELEMENT_CHARSET} should be used.
+     * If not defined then the 
+     * {@link org.apache.http.params.HttpProtocolParams#HTTP_ELEMENT_CHARSET
+     *        HttpProtocolParams.HTTP_ELEMENT_CHARSET}
+     * should be used.
      * <p>
      * This parameter expects a value of type {@link String}.
      * </p>
@@ -62,8 +65,11 @@ public final class AuthParams {
     }
 
     /**
-     * Returns the charset to be used when encoding {@link org.apache.http.auth.Credentials}.
+     * Defines the charset to be used when encoding
-     * If not configured the {@link HTTP.DEFAULT_PROTOCOL_CHARSET} is used instead.
+     * {@link org.apache.http.auth.Credentials}.
+     * If not configured,
+     * {@link HTTP#DEFAULT_PROTOCOL_CHARSET HTTP.DEFAULT_PROTOCOL_CHARSET}
+     * is used instead.
      * 
      * @return The charset
      */

src/java/org/apache/http/client/HttpState.java

@@ -138,9 +138,6 @@ public class HttpState {
      * state currently contains.
      * 
      * @return an array of {@link Cookie cookies}.
-     * 
-     * @see #getCookies(String, int, String, boolean)
-     * 
      */
     public synchronized Cookie[] getCookies() {
         return (Cookie[]) (cookies.toArray(new Cookie[cookies.size()]));
@@ -150,11 +147,9 @@ public class HttpState {
      * Removes all of {@link Cookie cookies} in this HTTP state
      * that have expired by the specified {@link java.util.Date date}. 
      * 
-     * @param date The {@link java.util.Date date} to compare against.
-     * 
      * @return true if any cookies were purged.
      * 
-     * @see Cookie#isExpired(java.util.Date)
+     * @see Cookie#isExpired()
      * 
      * @see #purgeExpiredCookies()
      */

src/java/org/apache/http/cookie/CookieSpecRegistry.java

@@ -84,7 +84,7 @@ public final class CookieSpecRegistry {
     /**
      * Unregisters the {@link CookieSpecFactory} with the given ID.
      * 
-     * @param name the identifier of the {@link CookieSpec cookie specification} to unregister
+     * @param id the identifier of the {@link CookieSpec cookie specification} to unregister
      */
     public synchronized void unregister(final String id) {
          if (id == null) {

src/java/org/apache/http/impl/auth/BasicScheme.java

@@ -84,7 +84,7 @@ public class BasicScheme extends RFC2617Scheme {
     /**
      * Processes the Basic challenge.
      *  
-     * @param challenge the challenge string
+     * @param header the challenge header
      * 
      * @throws MalformedChallengeException is thrown if the authentication challenge
      * is malformed

src/java/org/apache/http/impl/auth/DigestScheme.java

@@ -57,11 +57,12 @@ import org.apache.http.util.EncodingUtils;
  * </p>
  * <p>
  * Credential charset is configured via the 
- * {@link org.apache.commons.httpclient.params.HttpMethodParams#CREDENTIAL_CHARSET credential
+ * {@link AuthParams#CREDENTIAL_CHARSET credential charset} parameter.
- * charset} parameter.  Since the digest username is included as clear text in the generated 
+ * Since the digest username is included as clear text in the generated 
- * Authentication header, the charset of the username must be compatible with the 
+ * Authentication header, the charset of the username must be compatible
- * {@link org.apache.commons.httpclient.params.HttpMethodParams#HTTP_ELEMENT_CHARSET http element 
+ * with the 
- * charset}.
+ * {@link org.apache.http.params.HttpProtocolParams#HTTP_ELEMENT_CHARSET
+ *        http element charset}.
  * </p>
  * 
  * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
@@ -112,7 +113,7 @@ public class DigestScheme extends RFC2617Scheme {
     /**
      * Processes the Digest challenge.
      *  
-     * @param challenge the challenge string
+     * @param header the challenge header
      * 
      * @throws MalformedChallengeException is thrown if the authentication challenge
      * is malformed
@@ -198,7 +199,7 @@ public class DigestScheme extends RFC2617Scheme {
      * {@link Credentials}, method name and URI.
      * 
      * @param credentials A set of credentials to be used for athentication
-     * @param method The method being authenticated
+     * @param request    The request being authenticated
      * 
      * @throws InvalidCredentialsException if authentication credentials
      *         are not valid or not applicable for this authentication scheme

src/java/org/apache/http/impl/auth/RFC2617Scheme.java

@@ -78,7 +78,7 @@ public abstract class RFC2617Scheme implements 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
      * 
      * @throws MalformedChallengeException is thrown if the authentication challenge
      * is malformed