#include <DoxygenEssentials.h>
Public Types | |
enum | eNumbers { kOne, kTwo, kThree } |
A documented enumeration! More... | |
Public Member Functions | |
bool | isDocumented (int aParameter) |
A documented method. | |
Public Attributes | |
int | aField |
An example documented field. |
The Doxygenized class serves as a demonstration of how to document C++ code using Doxygen
bool Doxygenized::isDocumented | ( | int | aParameter | ) | [inline] |
A documented method.
The isDocumented method serves as an example of how to document methods, along with their parameters and return value.
aParameter | A documented method parameter. This parameter is not actually used. Its only purpose in life is to be documented |