Doxygen is a command line based utility. Calling
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:
doxygen -g <config_file>
If you have a configuration file generated with an older version of doxygen, you can upgrade it to the current version by running doxygen with the -u option.
doxygen -u <config_file>
All configuration settings in the original configuration file will be copied to the new configuration file. Any new options will have their default value. Note that comments that you may have added in the original configuration file will be lost.
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 <config_file>
config_file is optional. When omitted doxygen will search for a file named
Doxyfile and process that. When this is also not found it will used the default settings.
refman.tex(see LATEX_HEADER and LATEX_FOOTER) and the style sheet included by that header (normally
doxygen.sty), using the following command:
doxygen -w latex header.tex footer.tex doxygen.sty <config_file>If you need non-default options (for instance to use extra packages) you need to make a config file with those options set correctly and then specify that config file after the generated files (make a backup of the configuration file first so you don't loose it in case you forget to specify one of the output files).
doxygen -w rtf rtfstyle.cfg
-soption. This can use be used in combination with the
-uoption, to add or strip the documentation from an existing configuration file. Please use the
-soption if you send me a configuration file as part of a bug report!
-for the file name.