Doxygen

Main Page

How to Run

The Doxywizard pulls together the Doxygen file.  Open the command prompt and change the directory to the the doxygen_config file location.  Then type doxywizard doxygen_config.

Conventions

These conventions are tailored for visual studio intellisense to be able to pick them up.

.h files

Brief definitions (only) prior to enum

/*! <insert documentation here> */

Classes

Brief definitions for function declarations should precede the declaration

//! <documentation>

<return type> function();

Detailed definitions for function declarations should precede the definition

/*!

<documentation>

*/

<return type> <Class>::function(){

.

.

.

}

Brief definitions for variable declaration come after the declaration

type var; //!< <documentation here>