Linux command
doxygen 命令
文件
复制后可按需替换文件名、目录或参数。
常用示例
Generate default config
doxygen -g [Doxyfile]
Generate documentation
doxygen [Doxyfile]
Generate with updates
doxygen -u [Doxyfile]
Generate for wizard
doxywizard
说明
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.
参数
- -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.
FAQ
What is the doxygen command used for?
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.
How do I run a basic doxygen example?
Run `doxygen -g [Doxyfile]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does -g _FILE_ do in doxygen?
Generate default configuration file.