javadoc fixes

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

module-client/src/main/java/org/apache/http/cookie/Cookie.java

@@ -63,8 +63,6 @@ public interface Cookie {
      * <tt>null</tt> if no such comment has been defined.
      * 
      * @return comment 
-     *
-     * @see #setComment(String)
      */
     String getComment();
 
@@ -75,9 +73,6 @@ public interface Cookie {
      * considered immutable. Changing it (e.g. using setTime()) could result
      * in undefined behaviour. Do so at your peril. </p>
      * @return Expiration {@link Date}, or <tt>null</tt>.
-     *
-     * @see #setExpiryDate(java.util.Date)
-     *
      */
     Date getExpiryDate();
 
@@ -94,8 +89,6 @@ public interface Cookie {
      * Returns domain attribute of the cookie.
      * 
      * @return the value of the domain attribute
-     *
-     * @see #setDomain(java.lang.String)
      */
     String getDomain();
 
@@ -103,14 +96,14 @@ public interface Cookie {
      * Returns the path attribute of the cookie
      * 
      * @return The value of the path attribute.
-     * 
-     * @see #setPath(java.lang.String)
      */
     String getPath();
 
     /**
-     * @return <code>true</code> if this cookie should only be sent over secure connections.
-     * @see #setSecure(boolean)
+     * Indicates whether this cookie requires a secure connection.
+     *
+     * @return  <code>true</code> if this cookie should only be sent
+     *          over secure connections, <code>false</code> otherwise.
      */
     boolean isSecure();
 
@@ -119,9 +112,6 @@ public interface Cookie {
      * cookie conforms.
      *
      * @return the version of the cookie.
-     * 
-     * @see #setVersion(int)
-     *
      */
     int getVersion();
 
@@ -139,8 +129,6 @@ public interface Cookie {
      *
      * @return value <tt>true</tt> if the cookie's path was explicitly 
      * set, <tt>false</tt> otherwise.
-     * 
-     * @see #setPathAttributeSpecified
      */
     boolean isPathAttributeSpecified();
 
@@ -150,8 +138,6 @@ public interface Cookie {
      *
      * @return value <tt>true</tt> if the cookie's domain was explicitly 
      * set, <tt>false</tt> otherwise.
-     *
-     * @see #setDomainAttributeSpecified
      */
     boolean isDomainAttributeSpecified();
 

module-client/src/main/java/org/apache/http/impl/conn/tsccm/BadStaticMaps.java

@@ -88,10 +88,8 @@ final /*default*/ class BadStaticMaps {
     /**
      * Shuts down and cleans up resources used by all instances of 
      * ThreadSafeClientConnManager. All static resources are released, all threads are 
-     * stopped, and {@link #shutdown()} is called on all live instances of 
+     * stopped, and {@link ThreadSafeClientConnManager#shutdown()} is called on all live instances of 
      * ThreadSafeClientConnManager.
-     *
-     * @see #shutdown()
      */
     static /*default*/ void shutdownAll() {
 

module-client/src/main/java/org/apache/http/impl/conn/tsccm/RefQueueWorker.java

@@ -40,7 +40,7 @@ import org.apache.commons.logging.LogFactory;
 
 /**
  * A worker thread for processing queued references.
- * {@link References Reference}s can be
+ * {@link Reference Reference}s can be
  * {@link ReferenceQueue queued}
  * automatically by the garbage collector.
  * If that feature is used, a daemon thread should be executing

module-client/src/main/java/org/apache/http/impl/conn/tsccm/ThreadSafeClientConnManager.java

@@ -406,13 +406,6 @@ public class ThreadSafeClientConnManager
     }
 
 
-    // ######################################################################
-    // ######################################################################
-    // ##########               old code below                     ##########
-    // ######################################################################
-    // ######################################################################
-
-
     /**
      * Shuts down the connection manager and releases all resources.
      * All connections associated with this manager will be closed
@@ -666,7 +659,7 @@ public class ThreadSafeClientConnManager
          * Decrements any connection counts and notifies waiting threads,
          * if appropriate.
          * 
-         * @param config        the route of the connection that was lost
+         * @param route        the route of the connection that was lost
          */
         //@@@ temporary default visibility, for BadStaticMaps
         synchronized /*default*/
@@ -816,8 +809,6 @@ public class ThreadSafeClientConnManager
          * Notifies a waiting thread that a connection is available, by route.
          *
          * @param route         the route for which to notify
-         *
-         * @see #notifyWaitingThread(RouteConnPool)
          */
         public synchronized void notifyWaitingThread(HttpRoute route) {
             notifyWaitingThread(getRoutePool(route));
@@ -1099,28 +1090,5 @@ public class ThreadSafeClientConnManager
     } // class TrackingPoolEntry
 
 
-    /* *
-     * @@@ replace by separate class TSCCMConnAdapter
-     * A connection wrapper and callback handler.
-     * All connections given out by the manager are wrappers which
-     * can be {@link #detach detach}ed to prevent further use on release.
-     * /
-    private class HttpConnectionAdapter extends AbstractPooledConnAdapter {
-        //@@@ HTTPCLIENT-653
-        //@@@ this adapter being a nested class prevents proper detaching of
-        //@@@ the adapter from the manager, and therefore GC of the manager
-
-        / * *
-         * Creates a new adapter.
-         *
-         * @param entry   the pool entry for the connection being wrapped
-         * /
-        protected HttpConnectionAdapter(TrackingPoolEntry entry) {
-            super(ThreadSafeClientConnManager.this, entry);
-            super.markedReusable = true;
-        }
-    }
-    */
-
 } // class ThreadSafeClientConnManager