Doxygen manual manual#

When omitted doxygen will search for a file named Doxyfile and process that. 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:įor HTML output, you can generate the default header file (see HTML_HEADER), the default footer (see HTML_FOOTER), and the default style sheet (see HTML_STYLESHEET), using the following command: doxygen -w html header.html footer.html stylesheet.css Note that comments that you may have added in the original configuration file will be lost. Any new options will have their default value. doxygen -u Īll configuration settings in the original configuration file will be copied to the new configuration 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.

You let doxygen generate the documentation, based on the settings in the configuration file: doxygen In the configuration file you can specify the input files and a lot of optional information. You edit the configuration file so it matches your project. You generate a configuration file (see section Configuration) by calling doxygen with the -g option: doxygen -g You document your source code with special documentation blocks (see section Special comment blocks).

Doxygen manual manual#

To generate a manual for your project you typically need to follow these steps:

Calling doxygen with the -help option at the command line will give you a brief description of the usage of the program.Īll options consist of a leading character -, followed by one character and one or more arguments depending on the option.