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              If  - is used for configName doxygen will write to standard out‐
20              put.
21
22       2) Use doxygen to update an old configuration file:
23
24              doxygen [-s] -u [configName]
25
26       3) Use doxygen to generate documentation using an  existing  configura‐
27       tion file:
28
29              doxygen [configName]
30
31              If  -  is  used  for  configName doxygen will read from standard
32              input.
33
34       4) Use doxygen to generate a template file controlling  the  layout  of
35       the generated documentation:
36
37              doxygen -l [layoutFileName.xml]
38
39       5) Use doxygen to generate a template style sheet file for RTF, HTML or
40       Latex.
41
42       RTF:   doxygen -w rtf styleSheetFile
43
44       HTML:  doxygen -w html headerFile  footerFile  styleSheetFile  [config‐
45              File]
46
47       LaTeX:  doxygen  -w latex headerFile footerFile styleSheetFile [config‐
48       File]
49
50       6) Use doxygen to generate an rtf extensions file
51
52       RTF:   doxygen -e rtf extensionsFile
53
54       7) Use doxygen to compare the used configuration file with the template
55       configuration file
56
57       doxygen -x [configFile]
58
59       If -s is specified the comments in the config file will be omitted.  If
60       configName is omitted `Doxyfile' will be used as a default.
61

AUTHOR

63       Doxygen version @VERSION@, Copyright Dimitri van Heesch 1997-2015
64

SEE ALSO

66       doxywizard(1).
67
68
69
70doxygen @VERSION@                   @DATE@                          DOXYGEN(1)
Impressum