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:
Note:
- If you do not want the description for each item in the configuration file then you can use the optional
-s
option. Try to use this option if you send me a configuration file as part of a bug report! - To make doxygen read/write to standard input/output instead of from/to a file, use
-
for the file name.
If you also want to use the search engine, you should look at section Doxysearch usage.
Generated at Wed Feb 2 07:13:43 2000 by
1.0.0 written by Dimitri van Heesch,
© 1997-1999