Code Documentation Guidelines

All projects must properly document all classes and all public or protected methods that are part of the public API. By default, all classes and packages are part of the public API, unless its documentation explicitly states otherwise.

All classes and methods that contribute to a extension or plugin API must at least document the contract, and should also contain a programming guide, if the method's correct usage is not obvious otherwise. See Sun's JavaDoc Guidelines for Examples.

The purpose of a class or method and a general overview what this class or method does should be contained in the first paragraph. If you cannot fit the purpose into the paragraph or if you cannot describe the purpose in simple words, then refactor your code so that you can tell others what your code is supposed to do.