doxygen
with the --help
option at the command line will give you a brief description of the usage of the program.
All options consist of a leading character -
, followed by one character and one or more arguments depending on the option.
To generate a manual for your project you typically need to follow these steps:
-g
option: doxygen -g <config_file>
doxygen <config_file>
If you have a configuration file generated with an older version of doxygen that you can upgrade it to the current version by running doxygen with the -u option.
doxygen -u <config_file>
If you want to fine-tune the way the output looks, doxygen allows you generate default style sheet, header, and footer files that you can edit afterwards:
doxygen -w html header.html footer.html stylesheet.css
refman.tex
(see LATEX_HEADER) and the style sheet included by that header (normally doxygen.sty
), using: doxygen -w latex header.tex doxygen.sty
doxygen -w rtf rtfstyle.cfg
Note:
-s
option. This can use be used in combination with the -u
option, to add or strip the documentation from an existing configuration file. Please use the -s
this option if you send me a configuration file as part of a bug report! -
for the file name. If you also want to use the search engine, you should look at section Doxysearch usage.