1DOXYGEN(1) User Commands DOXYGEN(1)
2
3
4
6 doxygen - documentation system for various programming languages
7
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 style sheet file for RTF, HTML or
34 Latex.
35
36 RTF: doxygen -w rtf styleSheetFile
37
38 HTML: doxygen -w html headerFile footerFile styleSheetFile [config‐
39 File]
40
41 LaTeX: doxygen -w latex headerFile footerFile styleSheetFile [config‐
42 File]
43
44 5) Use doxygen to generate an rtf extensions file
45
46 RTF: doxygen -e rtf extensionsFile
47
48 If -s is specified the comments in the config file will be omitted. If
49 configName is omitted `Doxyfile' will be used as a default.
50
52 Doxygen version 1.7.4, Copyright Dimitri van Heesch 1997-2011
53
55 doxytag(1), doxywizard(1).
56
57
58
59doxygen 1.7.4 June 2011 DOXYGEN(1)