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 OrtwinGlueck: http://wiki.apache.org/jakarta-httpclient/HttpClientApiJavadocGuidelines ------------------------------------------------------------------------------ * 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. + * Statement whether this method is modal, that is, if the object must be in a specific state (pre-conditions) 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. + * Exceptions that can be thrown in the course of method's execution and their possible cause (post-conditions). + * private methods can have minimal or no JavaDoc if they are short and trivial enough. --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
