1 .TH DOXYGEN "1" "July 2010" "doxygen 1.7.0" "User Commands"
3 doxygen \- documentation system for various programming languages
5 Doxygen is a documentation system for C++, C, Java, Objective-C, IDL
6 (Corba and Microsoft flavors) and to some extent PHP, C#, and D.
8 You can use doxygen in a number of ways:
10 1) Use doxygen to generate a template configuration file:
12 doxygen [-s] \fB\-g\fR [configName]
14 If - is used for configName doxygen will write to standard output.
16 2) Use doxygen to update an old configuration file:
18 doxygen [-s] \fB\-u\fR [configName]
20 3) Use doxygen to generate documentation using an existing configuration file:
24 If - is used for configName doxygen will read from standard input.
26 4) Use doxygen to generate a template style sheet file for RTF, HTML or Latex.
29 doxygen \fB\-w\fR rtf styleSheetFile
32 doxygen \fB\-w\fR html headerFile footerFile styleSheetFile [configFile]
34 LaTeX: doxygen \fB\-w\fR latex headerFile styleSheetFile [configFile]
36 5) Use doxygen to generate an rtf extensions file
39 doxygen \fB\-e\fR rtf extensionsFile
41 If \fB\-s\fR is specified the comments in the config file will be omitted.
42 If configName is omitted `Doxyfile' will be used as a default.
44 Doxygen version 1.7.0, Copyright Dimitri van Heesch 1997-2007
46 doxytag(1), doxywizard(1).