|
Packit |
1c1d7e |
.TH DOXYGEN "1" "@DATE@" "doxygen @VERSION@" "User Commands"
|
|
Packit |
1c1d7e |
.SH NAME
|
|
Packit |
1c1d7e |
doxygen \- documentation system for various programming languages
|
|
Packit |
1c1d7e |
.SH DESCRIPTION
|
|
Packit |
1c1d7e |
Doxygen is a documentation system for C++, C, Java, Objective-C, IDL
|
|
Packit |
1c1d7e |
(Corba and Microsoft flavors) and to some extent PHP, C#, and D.
|
|
Packit |
1c1d7e |
.PP
|
|
Packit |
1c1d7e |
You can use doxygen in a number of ways:
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
1) Use doxygen to generate a template configuration file:
|
|
Packit |
1c1d7e |
.IP
|
|
Packit |
1c1d7e |
doxygen [-s] \fB\-g\fR [configName]
|
|
Packit |
1c1d7e |
.IP
|
|
Packit |
1c1d7e |
If - is used for configName doxygen will write to standard output.
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
2) Use doxygen to update an old configuration file:
|
|
Packit |
1c1d7e |
.IP
|
|
Packit |
1c1d7e |
doxygen [-s] \fB\-u\fR [configName]
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
3) Use doxygen to generate documentation using an existing configuration file:
|
|
Packit |
1c1d7e |
.IP
|
|
Packit |
1c1d7e |
doxygen [configName]
|
|
Packit |
1c1d7e |
.IP
|
|
Packit |
1c1d7e |
If - is used for configName doxygen will read from standard input.
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
4) Use doxygen to generate a template file controlling the layout of the generated documentation:
|
|
Packit |
1c1d7e |
.IP
|
|
Packit |
1c1d7e |
doxygen -l layoutFileName.xml
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex.
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
RTF:
|
|
Packit |
1c1d7e |
doxygen \fB\-w\fR rtf styleSheetFile
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
HTML:
|
|
Packit |
1c1d7e |
doxygen \fB\-w\fR html headerFile footerFile styleSheetFile [configFile]
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
LaTeX: doxygen \fB\-w\fR latex headerFile footerFile styleSheetFile [configFile]
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
6) Use doxygen to generate an rtf extensions file
|
|
Packit |
1c1d7e |
.TP
|
|
Packit |
1c1d7e |
RTF:
|
|
Packit |
1c1d7e |
doxygen \fB\-e\fR rtf extensionsFile
|
|
Packit |
1c1d7e |
.PP
|
|
Packit |
1c1d7e |
If \fB\-s\fR is specified the comments in the config file will be omitted.
|
|
Packit |
1c1d7e |
If configName is omitted `Doxyfile' will be used as a default.
|
|
Packit |
1c1d7e |
.SH AUTHOR
|
|
Packit |
1c1d7e |
Doxygen version @VERSION@, Copyright Dimitri van Heesch 1997-2015
|
|
Packit |
1c1d7e |
.SH SEE ALSO
|
|
Packit |
1c1d7e |
doxywizard(1).
|