Writing Documentation: Difference between revisions
Jump to navigation
Jump to search
(Beginnings of documentation of writing documentation ;-)) |
(No difference)
|
Revision as of 19:05, 22 February 2013
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.
/**
* Your documentation goes here.
*/
void doSomething();
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
Function Descriptions
- @brief descriptions: