1DOXYGEN(1)                       User Commands                      DOXYGEN(1)
2
3
4

NAME

6       doxygen - documentation system for various programming languages
7

DESCRIPTION

9       Doxygen  is  a  documentation system for C++, C, Java, Objective-C, IDL
10       (Corba and Microsoft flavors), Fortran, Python, VHDL and to some extent
11       PHP, C#, and D.
12
13       You can use doxygen in a number of ways:
14
15       1) Use doxygen to generate a template configuration file*:
16
17              doxygen [-s] -g [configName]
18
19       2) Use doxygen to update an old configuration file*:
20
21              doxygen [-s] -u [configName]
22
23       3)  Use  doxygen to generate documentation using an existing configura‐
24       tion file*:
25
26              doxygen [configName]
27
28       4) Use doxygen to generate a template file controlling  the  layout  of
29       the generated documentation:
30
31              doxygen -l [layoutFileName]
32
33          In  case layoutFileName is omitted DoxygenLayout.xml will be used as
34       filename.
35          If - is used for layoutFileName doxygen will write to standard  out‐
36       put.
37
38       5) Use doxygen to generate a template style sheet file for RTF, HTML or
39       Latex.
40
41              RTF: doxygen -w rtf styleSheetFile
42
43              HTML: doxygen -w html headerFile footerFile styleSheetFile [con‐
44              figFile]
45
46              LaTeX:  doxygen  -w  latex  headerFile footerFile styleSheetFile
47              [configFile]
48
49       6) Use doxygen to generate an rtf extensions file
50
51              RTF: doxygen -e rtf extensionsFile
52
53          If - is used for extensionsFile doxygen will write to standard  out‐
54       put.
55
56       7) Use doxygen to compare the used configuration file with the template
57       configuration file
58
59              doxygen -x [configFile]
60
61          Use doxygen to compare the used configuration file with the template
62       configuration file
63          without  replacing  the environment variables or CMake type replace‐
64       ment variables
65
66              doxygen -x_noenv [configFile]
67
68       8) Use doxygen to show a list of built-in emojis.
69
70              doxygen -f emoji outputFileName
71
72          If - is used for outputFileName doxygen will write to standard  out‐
73       put.
74
75       *)  If  -s  is specified the comments of the configuration items in the
76       config file will be omitted.
77          If configName is omitted 'Doxyfile' will be used as a default.
78          If - is used for configFile doxygen will write / read the configura‐
79       tion to /from standard output / input.
80
81       If -q is used for a doxygen documentation run, doxygen will see this as
82       if QUIET=YES has been set.
83
84       -v print version string, -V print extended version information
85
86       -h,-? prints usage help information
87
88       doxygen -d prints additional usage flags for debugging purposes
89

AUTHOR

91       Doxygen version @VERSION@, Copyright Dimitri van Heesch 1997-@YEAR@
92

SEE ALSO

94       doxywizard(1).
95
96
97
98doxygen @VERSION@                   @DATE@                          DOXYGEN(1)
Impressum