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 RolandWeber: http://wiki.apache.org/jakarta-httpclient/HttpClientApiJavadocGuidelines ------------------------------------------------------------------------------ * 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 (post-conditions). * private methods can have minimal or no JavaDoc if they are short and trivial enough. + * methods that implement a signature from an interface or base class that is sufficiently documented there can omit JavaDocs in favor of comments like: + {{{ // non-javadoc, see interface XXX }}} + + {{{ // non-javadoc, see class XYZ }}} + + The non-javadoc comment with a pointer to the documentation is required for people reading the source code. The JavaDoc tool will automatically copy the description from the interface or base class into the generated documentation. + --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
