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:
- You document your source code with special documentation blocks.
- You generate a configuration file (see section Configuration) by calling doxygen with the
-g
option: - 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.
- You let doxygen generate the documentation, based on the settings in the configuration file:
If you also want a search engine to be generated, you should look at section Doxysearch usage.
Generated at Thu Sep 2 10:59:30 1999 by
written by Dimitri van Heesch, © 1997-1999