javadoc fixes

git-svn-id: https://svn.apache.org/repos/asf/jakarta/httpcomponents/httpclient/trunk@558833 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Roland Weber 2007-07-23 19:02:32 +00:00
parent 8055cd1879
commit 5c4de73f6b
4 changed files with 7 additions and 55 deletions

View File

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

View File

@ -88,10 +88,8 @@ private BadStaticMaps() {
/** /**
* Shuts down and cleans up resources used by all instances of * Shuts down and cleans up resources used by all instances of
* ThreadSafeClientConnManager. All static resources are released, all threads are * 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. * ThreadSafeClientConnManager.
*
* @see #shutdown()
*/ */
static /*default*/ void shutdownAll() { static /*default*/ void shutdownAll() {

View File

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

View File

@ -406,13 +406,6 @@ public static void shutdownAll() {
} }
// ######################################################################
// ######################################################################
// ########## old code below ##########
// ######################################################################
// ######################################################################
/** /**
* Shuts down the connection manager and releases all resources. * Shuts down the connection manager and releases all resources.
* All connections associated with this manager will be closed * All connections associated with this manager will be closed
@ -666,7 +659,7 @@ public synchronized void handleReference(Reference ref) {
* Decrements any connection counts and notifies waiting threads, * Decrements any connection counts and notifies waiting threads,
* if appropriate. * 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 //@@@ temporary default visibility, for BadStaticMaps
synchronized /*default*/ synchronized /*default*/
@ -816,8 +809,6 @@ public synchronized void deleteLeastUsedConnection() {
* Notifies a waiting thread that a connection is available, by route. * Notifies a waiting thread that a connection is available, by route.
* *
* @param route the route for which to notify * @param route the route for which to notify
*
* @see #notifyWaitingThread(RouteConnPool)
*/ */
public synchronized void notifyWaitingThread(HttpRoute route) { public synchronized void notifyWaitingThread(HttpRoute route) {
notifyWaitingThread(getRoutePool(route)); notifyWaitingThread(getRoutePool(route));
@ -1098,29 +1089,6 @@ protected final ThreadSafeClientConnManager getManager() {
} // class TrackingPoolEntry } // 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 } // class ThreadSafeClientConnManager