Every class should be documented (this is the brief line) More...
#include <example_doc.h>
Public Member Functions | |
| int | reality (int hope, int despair) const |
| Each member function should be documented (this is the brief line) More... | |
Public Attributes | |
| int | datum |
| Each member datum needs at least a brief raison d'etre. More... | |
Detailed Description
Every class should be documented (this is the brief line)
This is the full text ... no need to be verbose but without documentation your class is nearly useless.
Member Function Documentation
| int ExampleClass1::reality | ( | int | hope, |
| int | despair | ||
| ) | const |
Each member function should be documented (this is the brief line)
Full documentation on member functions that computes 
.
You should document all arguments and return values.
- Parameters
-
[in] hope Optimism level [in] despair Pessimism level
- Returns
- Cynicism level
Member Data Documentation
| int ExampleClass1::datum |
Each member datum needs at least a brief raison d'etre.
The documentation for this class was generated from the following file:
