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 layoutFileName.xml will be
34              used as filename.  If - is used for layoutFileName doxygen  will
35              write to standard output.
36
37       5) Use doxygen to generate a template style sheet file for RTF, HTML or
38       Latex.
39
40              RTF: doxygen -w rtf styleSheetFile
41
42              HTML: doxygen -w html headerFile footerFile styleSheetFile [con‐
43              figFile]
44
45              LaTeX:  doxygen  -w  latex  headerFile footerFile styleSheetFile
46              [configFile]
47
48       6) Use doxygen to generate an rtf extensions file
49
50              RTF: doxygen -e rtf extensionsFile
51
52              If - is used for extensionsFile doxygen will write  to  standard
53              output.
54
55       7) Use doxygen to compare the used configuration file with the template
56       configuration file
57
58              doxygen -x [configFile]
59
60       8) Use doxygen to show a list of built-in emojis.
61
62              doxygen -f emoji outputFileName
63
64              If - is used for outputFileName doxygen will write  to  standard
65              output.
66
67       If -s is specified the comments in the config file will be omitted.  If
68       configName is omitted `Doxyfile' will be used as a default.   If  -  is
69       used  for  configFile  doxygen  will  write / read the configuration to
70       /from standard output / input.
71

AUTHOR

73       Doxygen version @VERSION@, Copyright Dimitri van Heesch 1997-2019
74

SEE ALSO

76       doxywizard(1).
77
78
79
80doxygen @VERSION@                   @DATE@                          DOXYGEN(1)
Impressum