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 32780] - Limited documentation for HttpClient constructors
Date Mon, 20 Dec 2004 15:33:49 GMT
DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG·
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=32780>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND·
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=32780





------- Additional Comments From ernst.dehaan@nl.wanadoo.com  2004-12-20 16:33 -------
Is the approach documented in any guidelines anywhere?

If this is the approach for Jakarta Commons, then I fully respect that.
Personally, I'm 'from a different school', though. I prefer full documentation,
explaining exactly and explicitly what behavior can be expected.

For the low-level open-source software libraries I manage/write (xmlenc, XINS,
etc.), I even specify the runtime exceptions that can be thrown. I specify for
every parameter explicitly whether it can be null and if not, what will happen.
Also, if the documentation for a parameter indicates it cannot be null but
actually is, then I log a programming error.

For an example, see:
http://cvs.sourceforge.net/viewcvs.py/xins/xins/src/java-common/org/xins/common/manageable/Manageable.java?rev=1.9&view=markup

Look at the bootstrap(PropertyReader) method, for example.

Again, I'm not suggesting this is the way it should be done for HttpClient, I'm
just explaining where I'm coming from and that there is room fur multiple
approaches. If my approach is incompatible, I'd like to get an overview of how
HttpClient is developed so if I suggest patches I can make them conformant.

-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

---------------------------------------------------------------------
To unsubscribe, e-mail: httpclient-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: httpclient-dev-help@jakarta.apache.org


Mime
View raw message