HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

doxygen — A documentation system for various programming languages. More information: <https://manned.org/doxy

Submitted by: @import:tldr-pages··
0
Viewed 0 times
clitldrcommand-linedoxygen
commandvariousdoxygencliprogrammingdocumentationforsystem

Problem

How to use the doxygen command: A documentation system for various programming languages. More information: <https://manned.org/doxygen>.

Solution

doxygen — A documentation system for various programming languages. More information: <https://manned.org/doxygen>.

Generate documentation, using Doxyfile as configuration file if it exists:
doxygen


Generate a default template configuration file Doxyfile:
doxygen -g


Generate a template configuration file:
doxygen -g {{path/to/config_file}}


Generate documentation using an existing configuration file:
doxygen {{path/to/config_file}}

Code Snippets

Generate documentation, using `Doxyfile` as configuration file if it exists

doxygen

Generate a default template configuration file `Doxyfile`

doxygen -g

Generate a template configuration file

doxygen -g {{path/to/config_file}}

Generate documentation using an existing configuration file

doxygen {{path/to/config_file}}

Context

tldr-pages: common/doxygen

Revisions (0)

No revisions yet.