hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bugzi...@apache.org
Subject DO NOT REPLY [Bug 22073] - Javadocs clean-up
Date Mon, 11 Aug 2003 07:22:59 GMT
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=22073>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=22073

Javadocs clean-up





------- Additional Comments From laura@lwerner.org  2003-08-11 07:22 -------
I only managed to do some cleanup HttpMethod and a little bit on HttpMethodBase
and HeaderGroup.  It was a lot more work than I thought, and it's time for bed.

I tried to specify the behavior of the functions more precisely than before,
using the HttpMethodBase implementation as a guide to what the functions do. 
Halfway through I started to wonder if this was a good idea, because there are
some functions where the current behavior is fairly strange and I'm not sure if
we want to codify it.  Please let me know what you think.  My opinion is that we
should be precise about what the methods do even if it's weird, because clients
of the API need to know.  It can always be cleaned up in 3.0.

Many of the methods interact in strange ways that I didn't know about
previously, and side-effects abound.  For example,
HttpMethodBase.getResponseBodyAsStream() only works if a) the body has not yet
been read, or b) the body was previously retrieved via a call to
getResponseBody() or getResponseBodyAsString().  Except that if
getResponseBodyAsStream() has been called previously and releaseConnection() has
not yet been called, it returns the same stream as the last time.

One more oddity: the generated documentation for HttpMethodBase looks odd in
Mozilla 1.4 on Windows XP -- the font looks larger and maybe different.  It's
fine in IE.  Could someone try this too so I know if it's just my system?

I'll attach the changes as a patch.  I'll try to do some more tomorrow.

Mime
View raw message