1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY doxygen-download-http "http://ftp.stack.nl/pub/doxygen/doxygen-&doxygen-version;.src.tar.gz">
|
---|
8 | <!ENTITY doxygen-download-ftp "ftp://ftp.stack.nl/pub/doxygen/doxygen-&doxygen-version;.src.tar.gz">
|
---|
9 | <!ENTITY doxygen-md5sum "3d1a5c26bef358c10a3894f356a69fbc">
|
---|
10 | <!ENTITY doxygen-size "4.8 MB">
|
---|
11 | <!ENTITY doxygen-buildsize "119 MB (with doxywizard - additional 26 MB for docs)">
|
---|
12 | <!ENTITY doxygen-time "1.7 SBU (with doxywizard - additional 1 SBU for docs)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="doxygen" xreflabel="Doxygen-&doxygen-version;">
|
---|
16 | <?dbhtml filename="doxygen.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>Doxygen-&doxygen-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="doxygen">
|
---|
26 | <primary sortas="a-Doxygen">Doxygen</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to Doxygen</title>
|
---|
31 |
|
---|
32 | <para>
|
---|
33 | The <application>Doxygen</application> package contains a documentation
|
---|
34 | system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP,
|
---|
35 | C# and D. It is useful for generating HTML documentation and/or an
|
---|
36 | off-line reference manual from a set of documented source files. There
|
---|
37 | is also support for generating output in RTF, PostScript, hyperlinked
|
---|
38 | PDF, compressed HTML, and Unix man pages. The documentation is extracted
|
---|
39 | directly from the sources, which makes it much easier to keep the
|
---|
40 | documentation consistent with the source code.
|
---|
41 | </para>
|
---|
42 |
|
---|
43 | <para>
|
---|
44 | You can also configure <application>Doxygen</application> to extract
|
---|
45 | the code structure from undocumented source files. This is very useful
|
---|
46 | to quickly find your way in large source distributions. Used along with
|
---|
47 | <application>Graphviz</application>, you can also visualize the relations
|
---|
48 | between the various elements by means of include dependency graphs,
|
---|
49 | inheritance diagrams, and collaboration diagrams, which are all generated
|
---|
50 | automatically.
|
---|
51 | </para>
|
---|
52 |
|
---|
53 | &lfs77_checked;
|
---|
54 |
|
---|
55 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
56 | <itemizedlist spacing="compact">
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download (HTTP): <ulink url="&doxygen-download-http;"/>
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Download (FTP): <ulink url="&doxygen-download-ftp;"/>
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Download MD5 sum: &doxygen-md5sum;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | <listitem>
|
---|
73 | <para>
|
---|
74 | Download size: &doxygen-size;
|
---|
75 | </para>
|
---|
76 | </listitem>
|
---|
77 | <listitem>
|
---|
78 | <para>
|
---|
79 | Estimated disk space required: &doxygen-buildsize;
|
---|
80 | </para>
|
---|
81 | </listitem>
|
---|
82 | <listitem>
|
---|
83 | <para>
|
---|
84 | Estimated build time: &doxygen-time;
|
---|
85 | </para>
|
---|
86 | </listitem>
|
---|
87 | </itemizedlist>
|
---|
88 |
|
---|
89 | <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
|
---|
90 |
|
---|
91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
92 | <para role="optional">
|
---|
93 | <xref linkend="graphviz"/>,
|
---|
94 | <xref linkend="gs"/>,
|
---|
95 | <xref linkend="llvm"/> (with clang),
|
---|
96 | <xref linkend="python2"/> or <xref linkend="python3"/>,
|
---|
97 | <xref linkend="qt4"/> (for doxywizard),
|
---|
98 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>) and
|
---|
99 | <xref linkend="xapian"/> (for doxyindexer)
|
---|
100 | </para>
|
---|
101 |
|
---|
102 | <para condition="html" role="usernotes">User Notes:
|
---|
103 | <ulink url="&blfs-wiki;/doxygen"/>
|
---|
104 | </para>
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2 role="installation">
|
---|
108 | <title>Installation of Doxygen</title>
|
---|
109 |
|
---|
110 | <para>
|
---|
111 | Install <application>Doxygen</application> by running the following
|
---|
112 | commands:
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <screen><userinput>./configure --prefix /usr \
|
---|
116 | --docdir /usr/share/doc/doxygen-&doxygen-version; &&
|
---|
117 | make</userinput></screen>
|
---|
118 |
|
---|
119 | <para>
|
---|
120 | This package does not come with a test suite.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | <para>
|
---|
124 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
125 | </para>
|
---|
126 |
|
---|
127 | <screen role="root"><userinput>make MAN1DIR=share/man/man1 install</userinput></screen>
|
---|
128 |
|
---|
129 | <para>
|
---|
130 | If you wish to generate and install the package documentation
|
---|
131 | (note that man pages have already been installed), you must have
|
---|
132 | <application>Python</application>,
|
---|
133 | <application>TeX Live</application> (for HTML docs) and
|
---|
134 | <application>Ghostscript</application> (for PDF docs)
|
---|
135 | installed, then issue the following command as the
|
---|
136 | <systemitem class="username">root</systemitem> user:
|
---|
137 | </para>
|
---|
138 |
|
---|
139 | <screen role="root"><userinput>make install_docs</userinput></screen>
|
---|
140 |
|
---|
141 | </sect2>
|
---|
142 |
|
---|
143 | <sect2 role="commands">
|
---|
144 | <title>Command Explanations</title>
|
---|
145 |
|
---|
146 | <para>
|
---|
147 | <option>--with-doxywizard</option>: Use this switch if
|
---|
148 | <application>Qt4</application> is installed and you wish to build the GUI
|
---|
149 | front-end. If both <application>Qt4</application> and
|
---|
150 | <application>Qt5</application> are installed, use <command>source
|
---|
151 | setqt4</command>. If <application>Qt4</application> is installed in
|
---|
152 | <filename class="directory">/opt</filename>, issue <command>export
|
---|
153 | QTDIR=$QT4DIR</command>.
|
---|
154 | </para>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | <option>--with-doxysearch</option>: Use this switch if
|
---|
158 | <application>xapian</application> is installed and you wish to build
|
---|
159 | external search tools (<command>doxysearch.cgi</command> and
|
---|
160 | <command>doxyindexer)</command>.
|
---|
161 | </para>
|
---|
162 |
|
---|
163 | <para>
|
---|
164 | <option>--with-libclang</option>: Use this switch if
|
---|
165 | <application>llvm</application> with <application>clang</application> are
|
---|
166 | installed, to add support for libclang parsing.</para>
|
---|
167 | </sect2>
|
---|
168 |
|
---|
169 | <sect2 role="configuration">
|
---|
170 | <title>Configuring Doxygen</title>
|
---|
171 |
|
---|
172 | <para>
|
---|
173 | There is no real configuration necessary for the
|
---|
174 | <application>Doxygen</application> package although three additional
|
---|
175 | packages are required if you wish to use extended capabilities. If you
|
---|
176 | need to use the language translation features, you must have <xref
|
---|
177 | linkend="python2"/> installed. If you require formulas to create PDF
|
---|
178 | documentation, then you must have <xref linkend="texlive"/> installed.
|
---|
179 | If you require formulas to convert PostScript files to bitmaps, then
|
---|
180 | you must have <xref linkend="gs"/> installed.
|
---|
181 | </para>
|
---|
182 |
|
---|
183 | </sect2>
|
---|
184 |
|
---|
185 | <sect2 role="content">
|
---|
186 | <title>Contents</title>
|
---|
187 |
|
---|
188 | <segmentedlist>
|
---|
189 | <segtitle>Installed Programs</segtitle>
|
---|
190 | <segtitle>Installed Libraries</segtitle>
|
---|
191 | <segtitle>Installed Directory</segtitle>
|
---|
192 |
|
---|
193 | <seglistitem>
|
---|
194 | <seg>
|
---|
195 | doxygen and optionally,
|
---|
196 | doxywizard, doxyindexer and doxysearch.cgi
|
---|
197 | </seg>
|
---|
198 | <seg>
|
---|
199 | None
|
---|
200 | </seg>
|
---|
201 | <seg>
|
---|
202 | /usr/share/doc/doxygen-&doxygen-version;
|
---|
203 | </seg>
|
---|
204 | </seglistitem>
|
---|
205 | </segmentedlist>
|
---|
206 |
|
---|
207 | <variablelist>
|
---|
208 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
209 | <?dbfo list-presentation="list"?>
|
---|
210 | <?dbhtml list-presentation="table"?>
|
---|
211 |
|
---|
212 | <varlistentry id="doxygen-prog">
|
---|
213 | <term><command>doxygen</command></term>
|
---|
214 | <listitem>
|
---|
215 | <para>
|
---|
216 | is a command-line based utility used to generate template
|
---|
217 | configuration files and then generate documentation from these
|
---|
218 | templates. Use <command>doxygen --help</command> for an
|
---|
219 | explanation of the command-line parameters.
|
---|
220 | </para>
|
---|
221 | <indexterm zone="doxygen doxygen-prog">
|
---|
222 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
223 | </indexterm>
|
---|
224 | </listitem>
|
---|
225 | </varlistentry>
|
---|
226 |
|
---|
227 | <varlistentry id="doxywizard">
|
---|
228 | <term><command>doxywizard</command></term>
|
---|
229 | <listitem>
|
---|
230 | <para>
|
---|
231 | is a GUI front-end for configuring and
|
---|
232 | running <command>doxygen</command>.
|
---|
233 | </para>
|
---|
234 | <indexterm zone="doxygen doxywizard">
|
---|
235 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
236 | </indexterm>
|
---|
237 | </listitem>
|
---|
238 | </varlistentry>
|
---|
239 |
|
---|
240 | <varlistentry id="doxyindexer">
|
---|
241 | <term><command>doxyindexer</command></term>
|
---|
242 | <listitem>
|
---|
243 | <para>
|
---|
244 | generates a search index called <filename>doxysearch.db</filename>
|
---|
245 | from one or more search data files produced by
|
---|
246 | <command>doxygen</command>. See, e.g. <ulink
|
---|
247 | url="http://www.stack.nl/~dimitri/doxygen/manual/extsearch.html"/>.
|
---|
248 | </para>
|
---|
249 | <indexterm zone="doxygen doxyindexer">
|
---|
250 | <primary sortas="b-doxyindexer">doxyindexer</primary>
|
---|
251 | </indexterm>
|
---|
252 | </listitem>
|
---|
253 | </varlistentry>
|
---|
254 |
|
---|
255 | <varlistentry id="doxysearch.cgi">
|
---|
256 | <term><command>doxysearch.cgi</command></term>
|
---|
257 | <listitem>
|
---|
258 | <para>
|
---|
259 | is a CGI program to search the data indexed by
|
---|
260 | <command>doxyindexer</command>.
|
---|
261 | </para>
|
---|
262 | <indexterm zone="doxygen doxysearch.cgi">
|
---|
263 | <primary sortas="b-doxysearch.cgi">doxysearch.cgi</primary>
|
---|
264 | </indexterm>
|
---|
265 | </listitem>
|
---|
266 | </varlistentry>
|
---|
267 |
|
---|
268 | </variablelist>
|
---|
269 |
|
---|
270 | </sect2>
|
---|
271 |
|
---|
272 | </sect1>
|
---|