Doxygen

Table of Contents

The documentation is like this:

/**
 * \brief Brief
 *
 * Some documents.
 */

Define a group and subgroups by:

/**
 * \defgroup mygroup
 * Can only define once.
 * This must be in its own group, otherwise the documented thing will not be in the group.
 */

/**
 * \defgroup mysubgroup
 * \ingroup mygroup
 * This is a subgroup of \ref mygroup
 */

/**
 * \ingroup mygroup
 * This class will be inside mygroup
 */

/**
 * \addtogroup mygroup
 * @{
 * everything in between will be put into that group
 * This commend actaully weakly define a group.
 */

/** @}*/

Main page can be specified in \mainpage TITLE block.

1 Configuration

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
aPROJECT_NAME           = "Helium"
OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/doxygen

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES

#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------

#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src @CMAKE_CURRENT_SOURCE_DIR@/include
RECURSIVE              = YES
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------

#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
UML_LOOK               = NO

Author: Hebi Li

Created: 2017-03-27 Mon 14:36

Validate