olegk 2004/12/20 11:52:50
Modified: httpclient/src/java/org/apache/commons/httpclient
HttpConnection.java HttpVersion.java
Log:
Javadoc fixes
Contributed by Ernst de Haan <ernst.dehaan at nl.wanadoo.com> and Oleg
Kalnichevski
Revision Changes Path
1.104 +19 -7
jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java
Index: HttpConnection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java,v
retrieving revision 1.103
retrieving revision 1.104
diff -u -r1.103 -r1.104
--- HttpConnection.java 3 Nov 2004 19:37:10 -0000 1.103
+++ HttpConnection.java 20 Dec 2004 19:52:50 -0000 1.104
@@ -1162,7 +1162,12 @@
}
/**
- * Release the connection.
+ * Releases the connection. If the connection is locked or does not have
a connection
+ * manager associated with it, this method has no effect. Note that it
is completely safe
+ * to call this method multiple times.
+ *
+ * @see #isLocked()
+ * @see #setLocked(boolean)
*/
public void releaseConnection() {
LOG.trace("enter HttpConnection.releaseConnection()");
@@ -1177,7 +1182,10 @@
}
/**
- * @return
+ * Tests if the connection is locked. Locked connections cannot be
released.
+ * An attempt to release a locked connection will have no effect.
+ *
+ * @return <tt>true</tt> if the connection is locked, <tt>false</tt>
otherwise.
*
* @since 3.0
*/
@@ -1186,7 +1194,11 @@
}
/**
- * @param locked
+ * Locks or unlocks the connection. Locked connections cannot be
released.
+ * An attempt to release a locked connection will have no effect.
+ *
+ * @param locked <tt>true</tt> to lock the connection, <tt>false</tt> to
unlock
+ * the connection.
*
* @since 3.0
*/
1.6 +9 -9
jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpVersion.java
Index: HttpVersion.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpVersion.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HttpVersion.java 13 May 2004 04:03:25 -0000 1.5
+++ HttpVersion.java 20 Dec 2004 19:52:50 -0000 1.6
@@ -32,17 +32,17 @@
/**
* <p>HTTP version, as specified in RFC 2616.</p>
* <p>
- * HTTP uses a "<major>.<minor>" numbering scheme to indicate
versions
- * of the protocol. The protocol versioning policy is intended to allow
- * the sender to indicate the format of a message and its capacity for
+ * HTTP uses a "<major>.<minor>" numbering scheme to indicate
+ * versions of the protocol. The protocol versioning policy is intended to
+ * allow the sender to indicate the format of a message and its capacity for
* understanding further HTTP communication, rather than the features
* obtained via that communication. No change is made to the version
* number for the addition of message components which do not affect
* communication behavior or which only add to extensible field values.
- * The <minor> number is incremented when the changes made to the
+ * The <minor> number is incremented when the changes made to the
* protocol add features which do not change the general message parsing
* algorithm, but which may add to the message semantics and imply
- * additional capabilities of the sender. The <major> number is
+ * additional capabilities of the sender. The <major> number is
* incremented when the format of a message within the protocol is
* changed. See RFC 2145 [36] for a fuller explanation.
* </p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
