Writing Documentation

We use Doxygen to generate documentation, and make use of the JavaDoc style. They go in the header next to the declaration, all classes should have at a minimum a brief description with one or two sentences explaining what the intended purpose of the class is.

=Class Descriptions=


 * Minimum of a brief overview of the class
 * Add include path for users of the class
 * If appropriate, point out alternate/similar classes
 * Ideally give some simple examples of using the class
 * Demonstrate core functionality in the simplest way possible

=Function Descriptions=


 * @brief descriptions:
 * Use complete sentences
 * Constructors should be more that "Constructor", such as "Constructs the ... with ..."
 * Use complete sentences to describe parameters