LinuxCommandLibrary

doxygen

TLDR

Generate default config file

$ doxygen -g [Doxyfile]
copy
Generate documentation
$ doxygen [Doxyfile]
copy
Generate with updates to config
$ doxygen -u [Doxyfile]
copy
Generate for wizard GUI
$ doxywizard
copy

SYNOPSIS

doxygen [options] [configfile]

DESCRIPTION

Doxygen is the standard documentation generator for C++, C, Java, Python, and other languages. It extracts documentation from specially-formatted comments in source code and generates output in HTML, LaTeX, RTF, and other formats.
The tool parses source code, builds a cross-referenced documentation structure, and renders it with class diagrams, call graphs, and inheritance trees. Special comment markers (///, /**, etc.) identify documentation blocks.
Doxygen supports Markdown in comments and can generate documentation from plain header files without inline comments.

PARAMETERS

CONFIGFILE

Configuration file (default: Doxyfile).
-g [FILE]
Generate default configuration file.
-u [FILE]
Update config file to current version.
-s
Omit comments in generated config.
-l
Generate layout file.
-w
Generate style sheets.
-v, --version
Show version.
--help
Display help information.

CAVEATS

Complex projects need extensive configuration. Large codebases may take time to process. Graphviz required for diagrams. Output quality depends on comment quality.

HISTORY

Doxygen was created by Dimitri van Heesch and first released in 1997. It became the de facto standard for C/C++ documentation, supporting additional languages and output formats over time.

SEE ALSO

Copied to clipboard