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) and to some extent PHP, C#, and D.
11
12       You can use doxygen in a number of ways:
13
14       1) Use doxygen to generate a template configuration file:
15
16              doxygen [-s] -g [configName]
17
18              If - is used for configName doxygen will write to standard  out‐
19              put.
20
21       2) Use doxygen to update an old configuration file:
22
23              doxygen [-s] -u [configName]
24
25       3)  Use  doxygen to generate documentation using an existing configura‐
26       tion file:
27
28              doxygen [configName]
29
30              If - is used for configName  doxygen  will  read  from  standard
31              input.
32
33       4)  Use  doxygen  to generate a template file controlling the layout of
34       the generated documentation:
35
36              doxygen -l layoutFileName.xml
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 [config‐
44              File]
45
46       LaTeX: doxygen -w latex headerFile footerFile  styleSheetFile  [config‐
47       File]
48
49       6) Use doxygen to generate an rtf extensions file
50
51       RTF:   doxygen -e rtf extensionsFile
52
53       If -s is specified the comments in the config file will be omitted.  If
54       configName is omitted `Doxyfile' will be used as a default.
55

AUTHOR

57       Doxygen version 1.8.5, Copyright Dimitri van Heesch 1997-2013
58

SEE ALSO

60       doxywizard(1).
61
62
63
64doxygen 1.8.5                      June 2014                        DOXYGEN(1)
Impressum