Doxygen usage

Doxygen is a command line based utility. Calling doxygen with the -h 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 optionally an argument.

To generate a class browser you typically need to follow these steps:

1. You document your source code with special documentation blocks.
2. You generate a configuration file by calling doxygen with the -g option:

   doxygen -g <config_file>
   

3. You edit the configuration file so it matches your project. In the configuration file you can specify the input files and a lot of optional information.
4. You let doxygen generate the documentation, based on the settings in the configuration file:

   doxygen <config_file>
   

If you also want a search engine to be generated, you should look at section "Doxysearch usage".

---