Instead of simply using doxygen from a GUI or through a CMake package, its important to understand how the underlying doxygen executable actually works. This repo includes:
config.doxygen: Template for Main Doxygen configuration which is passed to the executable.layout.doxygen: Template for a Doxygen layout configuration file, optionally passed to the executable.
You can use doxygen in a number of ways:
-
Use doxygen to generate a template configuration file*: doxygen [-s] -g [configName]
-
Use doxygen to update an old configuration file*: doxygen [-s] -u [configName]
-
Use doxygen to generate documentation using an existing configuration file*: doxygen [configName]
-
Use doxygen to generate a template file controlling the layout of the generated documentation: doxygen -l [layoutFileName]
In case layoutFileName is omitted DoxygenLayout.xml will be used as filename. If - is used for layoutFileName doxygen will write to standard output.
-
Use doxygen to generate a template style sheet file for RTF, HTML or Latex. RTF: doxygen -w rtf styleSheetFile HTML: doxygen -w html headerFile footerFile styleSheetFile [configFile] LaTeX: doxygen -w latex headerFile footerFile styleSheetFile [configFile]
-
Use doxygen to generate a rtf extensions file doxygen -e rtf extensionsFile
If - is used for extensionsFile doxygen will write to standard output.
-
Use doxygen to compare the used configuration file with the template configuration file doxygen -x [configFile]
Use doxygen to compare the used configuration file with the template configuration file without replacing the environment variables or CMake type replacement variables doxygen -x_noenv [configFile]
-
Use doxygen to show a list of built-in emojis. doxygen -f emoji outputFileName
If - is used for outputFileName doxygen will write to standard output.
*) If -s is specified the comments of the configuration items in the config file will be omitted. If configName is omitted 'Doxyfile' will be used as a default. If - is used for configFile doxygen will write / read the configuration to /from standard output / input.
If -q is used for a doxygen documentation run, doxygen will see this as if QUIET=YES has been set.
-v print version string, -V print extended version information -h,-? prints usage help information doxygen -d prints additional usage flags for debugging purposes