1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Doxygen: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Doxygen
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Doxygen Documentation</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><center>
<img src="doxygen_logo.gif" width="634" height="197" alt="doxygen"/><br/>
Version:
</center><h2>Introduction</h2>
<p>Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.</p>
<p>Doxygen can help you in three ways: </p><ol>
<li>
It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/>) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. </li>
<li>
You can <a class="el" href="starting.html#extract_all">configure</a> doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. Doxygen can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically. </li>
<li>
You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and web-site). </li>
</ol>
<p>Doxygen is developed under Mac OS X and Linux, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available.</p>
<p><br />
This manual is divided into three parts, each of which is divided into several sections.</p>
<p>The first part forms a user manual: </p><ul>
<li>
Section <a class="el" href="install.html">Installation</a> discusses how to <a href="http://www.doxygen.org/download.html">download</a>, compile and install doxygen for your platform. </li>
<li>
Section <a class="el" href="starting.html">Getting started</a> tells you how to generate your first piece of documentation quickly. </li>
<li>
Section <a class="el" href="docblocks.html">Documenting the code</a> demonstrates the various ways that code can be documented. </li>
<li>
Section <a class="el" href="markdown.html">Markdown support</a> show the Markdown formatting supported by doxygen. </li>
<li>
Section <a class="el" href="lists.html">Lists</a> shows how to create lists. </li>
<li>
Section <a class="el" href="grouping.html">Grouping</a> shows how to group things together. </li>
<li>
Section <a class="el" href="formulas.html">Including formulas</a> shows how to insert formulas in the documentation. </li>
<li>
Section <a class="el" href="diagrams.html">Graphs and diagrams</a> describes the diagrams and graphs that doxygen can generate. </li>
<li>
Section <a class="el" href="preprocessing.html">Preprocessing</a> explains how doxygen deals with macro definitions. </li>
<li>
Section <a class="el" href="autolink.html">Automatic link generation</a> shows how to put links to files, classes, and members in the documentation. </li>
<li>
Section <a class="el" href="output.html">Output Formats</a> shows how to generate the various output formats supported by doxygen. </li>
<li>
Section <a class="el" href="searching.html">Searching</a> shows various ways to search in the HTML documentation. </li>
<li>
Section <a class="el" href="extsearch.html">External Indexing and Searching</a> shows how use the external search and index tools </li>
<li>
Section <a class="el" href="customize.html">Customizing the output</a> explains how you can customize the output generated by doxygen. </li>
<li>
Section <a class="el" href="custcmd.html">Custom Commands</a> show how to define and use custom commands in your comments. </li>
<li>
Section <a class="el" href="external.html">Linking to external documentation</a> explains how to let doxygen create links to externally generated documentation. </li>
<li>
Section <a class="el" href="faq.html">Frequently Asked Questions</a> gives answers to frequently asked questions. </li>
<li>
Section <a class="el" href="trouble.html">Troubleshooting</a> tells you what to do when you have problems. </li>
</ul>
<p>The second part forms a reference manual:</p>
<ul>
<li>
Section <a class="el" href="features.html">Features</a> presents an overview of what doxygen can do. </li>
<li>
Section <a class="el" href="doxygen_usage.html">Doxygen usage</a> shows how to use the <code>doxygen</code> program. </li>
<li>
Section <a class="el" href="doxywizard_usage.html">Doxywizard usage</a> shows how to use the <code>doxywizard</code> program. </li>
<li>
Section <a class="el" href="config.html">Configuration</a> shows how to fine-tune doxygen, so it generates the documentation you want. </li>
<li>
Section <a class="el" href="commands.html">Special Commands</a> shows an overview of the special commands that can be used within the documentation. </li>
<li>
Section <a class="el" href="htmlcmds.html">HTML Commands</a> shows an overview of the HTML commands that can be used within the documentation. </li>
<li>
Section <a class="el" href="xmlcmds.html">XML Commands</a> shows an overview of the C# style XML commands that can be used within the documentation. </li>
</ul>
<p>The third part provides information for developers:</p>
<ul>
<li>
Section <a class="el" href="arch.html">Doxygen's Internals</a> gives a global overview of how doxygen is internally structured. </li>
<li>
Section <a class="el" href="perlmod.html">Perl Module Output</a> shows how to use the PerlMod output. </li>
<li>
Section <a class="el" href="langhowto.html">Internationalization</a> explains how to add support for new output languages. </li>
</ul>
<p><br />
</p><h2>Doxygen license</h2>
<p><a name="alicense"></a> <a name="aGPL"></a></p>
<p>Copyright © 1997-2016 by <a href="#" onclick="location.href='mai'+'lto:'+'dim'+'it'+'ri@'+'st'+'ack'+'.n'+'l'; return false;">Dimitri van Heesch</a>.</p>
<p>Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU General Public License</a> for more details. </p>
<p>Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.</p>
<h2>User examples</h2>
<p>Doxygen supports a number of <a class="el" href="output.html">output formats</a> where HTML is the most popular one. I've gathered <a href="http://www.doxygen.org/results.html">some nice examples</a> of real-life projects using doxygen.</p>
<p>These are part of a larger <a href="http://www.doxygen.org/projects.html">list of projects</a> that use doxygen. If you know other projects, let <a href="#" onclick="location.href='mai'+'lto:'+'dim'+'it'+'ri@'+'st'+'ack'+'.n'+'l?s'+'ub'+'jec'+'t='+'New'+'%2'+'0pr'+'oj'+'ect'+'%2'+'0us'+'in'+'g%2'+'0D'+'oxy'+'ge'+'n'; return false;">me</a> know and I'll add them.</p>
<h2>Future work</h2>
<p>Although doxygen is successfully used by large number of companies and open source projects already, there is always room for improvement. </p>
<p>You can submit enhancement requests in <a href="https://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=enhancement">the bug tracker</a>. Make sure the severity of the bug report is set to "enhancement".</p>
<h2>Acknowledgments</h2>
<p><a name="aacknowledgments"></a> Thanks go to: </p><ul>
<li>
<a name="aDoc:2b:2b"></a> Malte Zöckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen. </li>
<li>
All people at Qt Software, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-) </li>
<li>
My brother Frank for rendering the logos. </li>
<li>
Harm van der Heijden for adding HTML help support. </li>
<li>
Wouter Slegers of <a href="http://www.yourcreativesolutions.nl">Your Creative Solutions</a> for registering the www.doxygen.org domain. </li>
<li>
Parker Waechter for adding the RTF output generator. </li>
<li>
Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator. </li>
<li>
Tim Mensch for adding the todo command. </li>
<li>
Christian Hammond for redesigning the web-site. </li>
<li>
Ken Wong for providing the HTML tree view code. </li>
<li>
Talin for adding support for C# style comments with XML markup. </li>
<li>
Petr Prikryl for coordinating the internationalization support. All language maintainers for providing translations into many languages. </li>
<li>
The band <a href="http://www.porcupinetree.com">Porcupine Tree</a> for providing hours of great music to listen to while coding. </li>
<li>
many, many others for suggestions, patches and bug reports. </li>
</ul>
<p>
Go to the <a href="install.html">next</a> section.
</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
</ul>
</div>
</body>
</html>
|
