Automatically Generating doxygen Documentation in Visual Studio
To automatically generate doxygen
HTML documentation for your classes after a build, complete the following steps.
- Download the binary distribution of
doxygen
for Windows. - Create a folder
docs
within the main project. - Execute the following command to generate a
doxygen
configuration file. (Put it in thedocs
folder.)doxygen -g CustomList.doxygen
- Set the following variables in the
doxygen
configuration file:PROJECT_NAME
,OUTPUT_DIRECTORY
,EXTRACT_ALL
,EXCLUDE
,GENERATE_LATEX
- Add the following line to the “Post-build event command line” text box under the project’s build events.
doxygen $(ProjectDir)docs\$(ProjectName).doxygen
- Rebuild your project.
Relevant Variables
Variable Name (Tag) | Description | Default | For Exploring |
---|---|---|---|
PROJECT_NAME |
Single word (or sequence of words in double quotes) that identifies project | ||
OUTPUT_DIRECTORY |
Relative or absolute directory into which documentation will be written | ||
EXTRACT_ALL |
Whether to document all entities | NO |
YES |
EXTRACT_PRIVATE |
Whether to include private members | NO |
YES |
EXTRACT_PACKAGE |
Whether to include package members | NO |
YES |
EXTRACT_STATIC |
Whether to include static members | NO |
YES |
INPUT |
Files and/or directories that contain documented source files, separated with spaces. | ||
RECURSIVE |
Whether subjectories should be searched for input files | NO |
YES |
GENERATE_LATEX |
Whether to generate LaTeX output | YES |
YES |