Doxygenized Class Reference
[Documented Stuff]

A documented C++ class! More...

#include <DoxygenEssentials.h>

List of all members.

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.


Detailed Description

A documented C++ class!

The Doxygenized class serves as a demonstration of how to document C++ code using Doxygen


Member Enumeration Documentation

A documented enumeration!

An example of documenting an enumeration and its members using the shorthand for placing documentation inline with declarations

Enumerator:
kOne  The number One.
kTwo  The number Two.
kThree  The Number Three.


Member Function Documentation

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.

Returns:
Always returns true, because this is a contrived example
Parameters:
aParameter A documented method parameter. This parameter is not actually used. Its only purpose in life is to be documented


The documentation for this class was generated from the following file:

Generated on Mon Jul 28 16:32:40 2008 by  doxygen 1.5.5