hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Jakarta-httpclient Wiki] Update of "HttpClientApiJavadocGuidelines" by OlegKalnichevski
Date Mon, 18 Jul 2005 20:13:08 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jakarta-httpclient Wiki" for change
notification.

The following page has been changed by OlegKalnichevski:
http://wiki.apache.org/jakarta-httpclient/HttpClientApiJavadocGuidelines

New page:
= HttpClient 4.0 Javadoc guidelines: =

== Interface description must consist of ==
 * Purpose
 * Description (''optional'')
 * Statement whether this interface represents an entity or a process defined by a standard
specification such as RFC document, when applicable (''optional'')

== Class description must consist of ==
 * Purpose
 * Description (''optional'')
 * Statement whether this class implements an entity or a process defined by a standard specification
such as RFC document, when applicable (''optional'')
 * Statement whether instances of this class are mutable (''optional''). If not explicitly
stated, instances of this class are assumed to be mutable
 * Statement whether this class is multi-threading safe (''optional''). If not explicitly
stated, the class is assumed to be '''NOT''' threading-safe

== Method description must consist of ==
 * Purpose
 * Expected effect
 * Description (''optional'')
 * Statement whether this method is modal, that is, if the class must be in a specific state
or mode in order to execute correctly (''optional''). If not explicitly stated, the method
is assumed to be non-modal. 
 * Required parameters. It must be explicitly stated whether null is permitted as a parameter
value. Per default parameters are assumed to require a non-null value and to cause a {{{ IllegalArgumentException
}}} if null is given.
 * Exceptions that can be thrown in the course of method's execution and their possible cause.

---------------------------------------------------------------------
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