UNB/ CS/ David Bremner/ teaching/ old/ cs2023/ Doxygen

Example Doxyfile, with custom side_effect command

PROJECT_NAME="CS2023 Week 7 Examples"
ALIASES = side_effect="\par Side Effects:\n" 
OPTIMIZE_OUTPUT_FOR_C           =YES
SOURCE_BROWSER          =NO
GENERATE_LATEX          =NO
REFERENCED_BY_RELATION  =YES
REFERENCES_RELATION     =YES
SEARCHENGINE            =NO
EXTRACT_ALL             =YES

Sample function header

/** 
 * @brief classify 5 cards according to poker
 *        rules
 *
 * Determines whether the hand contains a
 * straight, a flush, four-of-a-kind, and/or
 * three-of-a-kind; determines the number of
 * pairs.
 * 
 * @side_effect stores the classification into
 *   external variables.
 */
void analyze_hand(void){
};

Correponding Doxygen output

Doxyexample