source: general/prog/doxygen.xml@ 1159b21

10.0 10.1 11.0 11.1 11.2 9.0 9.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 1159b21 was 1159b21, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22019 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 9.7 KB
Line 
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://doxygen.nl/files/doxygen-&doxygen-version;.src.tar.gz">
8 <!ENTITY doxygen-download-ftp " ">
9 <!ENTITY doxygen-md5sum "3ec5f8bfda38a05845161fbbd5d8b439">
10 <!ENTITY doxygen-size "5.2 MB">
11 <!ENTITY doxygen-buildsize "159 MB (with tests)">
12 <!ENTITY doxygen-time "0.9 SBU (using parallelism=4; with tests)">
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 &lfs90_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">Additional Downloads</bridgehead>
90 <itemizedlist spacing='compact'>
91 <listitem>
92 <para>Required patch: <ulink
93 url="&patch-root;/doxygen-&doxygen-version;-flex_2_6_0_fix-1.patch"/></para>
94 </listitem>
95 </itemizedlist>-->
96
97 <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
98
99 <bridgehead renderas="sect4">Required</bridgehead>
100 <para role="required">
101 <xref linkend="cmake"/>
102 </para>
103
104 <bridgehead renderas="sect4">Optional</bridgehead>
105 <para role="optional">
106 <xref linkend="graphviz"/>,
107 <xref linkend="gs"/>,
108 <xref linkend="libxml2"/> (required for the tests),
109 <xref linkend="llvm"/> (with clang),
110 <!-- Can someone check this? With LLVM7, it fails to build. -->
111 <xref linkend="python2"/>,
112 <xref linkend="qt5"/> (for doxywizard),
113 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>), and
114 <xref linkend="xapian"/> (for doxyindexer)
115 </para>
116
117 <para condition="html" role="usernotes">User Notes:
118 <ulink url="&blfs-wiki;/doxygen"/>
119 </para>
120 </sect2>
121
122 <sect2 role="installation">
123 <title>Installation of Doxygen</title>
124
125 <para>
126 Install <application>Doxygen</application> by running the following
127 commands:
128 </para>
129
130<screen><userinput>mkdir -v build &amp;&amp;
131cd build &amp;&amp;
132
133cmake -G "Unix Makefiles" \
134 -DCMAKE_BUILD_TYPE=Release \
135 -DCMAKE_INSTALL_PREFIX=/usr \
136 -Wno-dev .. &amp;&amp;
137
138make</userinput></screen>
139
140 <para>
141 To test the results, issue: <command>make tests</command>. One test,
142 012_cite.dox, is known to fail.
143 </para>
144
145 <para>
146 If you wish to generate the package documentation, you must have
147 <application>Python</application>, <application>TeX Live</application>
148 (for HTML docs) and <application>Ghostscript</application> (for PDF docs)
149 installed, then issue the following command:
150 </para>
151
152<screen remap="doc"><userinput>cmake -DDOC_INSTALL_DIR=share/doc/doxygen-&doxygen-version; -Dbuild_doc=ON .. &amp;&amp;
153
154make docs</userinput></screen>
155
156 <para>
157 Now, as the <systemitem class="username">root</systemitem> user:
158 </para>
159
160<screen role="root"><userinput>make install &amp;&amp;
161install -vm644 ../doc/*.1 /usr/share/man/man1</userinput></screen>
162
163 <para>
164 If you have generated the package documentation, then the man pages are
165 automatically installed, and you do not need to run the last
166 <command>install ...</command> command.
167 </para>
168
169 </sect2>
170
171 <sect2 role="commands">
172 <title>Command Explanations</title>
173
174 <para>
175 <option>-Dbuild_wizard=ON</option>: Use this switch if
176 <application>Qt5</application> is installed and you wish to build the GUI
177 front-end.
178 </para>
179
180 <para>
181 <option>-Dbuild_search=ON</option>: Use this switch if
182 <application>xapian</application> is installed and you wish to build
183 external search tools (<command>doxysearch.cgi</command> and
184 <command>doxyindexer)</command>.
185 </para>
186<!--
187 <para>
188 <option>-Dforce_qt4=ON</option>: Use this switch to build
189 <command>doxywizard</command> with Qt4 even if Qt5 is installed.
190 </para>-->
191
192 <para>
193 <option>-Duse_libclang=ON</option>: Use this switch if
194 <application>llvm</application> with <application>clang</application> are
195 installed, to add support for libclang parsing.
196 </para>
197
198 </sect2>
199
200 <sect2 role="configuration">
201 <title>Configuring Doxygen</title>
202
203 <para>
204 There is no real configuration necessary for the
205 <application>Doxygen</application> package although three additional
206 packages are required if you wish to use extended capabilities. If you
207 need to use the language translation features, you must have <xref
208 linkend="python2"/> installed. If you require formulas to create PDF
209 documentation, then you must have <xref linkend="texlive"/> installed.
210 If you require formulas to convert PostScript files to bitmaps, then
211 you must have <xref linkend="gs"/> installed.
212 </para>
213
214 </sect2>
215
216 <sect2 role="content">
217 <title>Contents</title>
218
219 <segmentedlist>
220 <segtitle>Installed Programs</segtitle>
221 <segtitle>Installed Libraries</segtitle>
222 <segtitle>Installed Directory</segtitle>
223
224 <seglistitem>
225 <seg>
226 doxygen and optionally,
227 doxywizard, doxyindexer and doxysearch.cgi
228 </seg>
229 <seg>
230 None
231 </seg>
232 <seg>
233 /usr/share/doc/doxygen-&doxygen-version;
234 </seg>
235 </seglistitem>
236 </segmentedlist>
237
238 <variablelist>
239 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
240 <?dbfo list-presentation="list"?>
241 <?dbhtml list-presentation="table"?>
242
243 <varlistentry id="doxygen-prog">
244 <term><command>doxygen</command></term>
245 <listitem>
246 <para>
247 is a command-line based utility used to generate template
248 configuration files and then generate documentation from these
249 templates. Use <command>doxygen --help</command> for an
250 explanation of the command-line parameters.
251 </para>
252 <indexterm zone="doxygen doxygen-prog">
253 <primary sortas="b-doxygen">doxygen</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="doxywizard">
259 <term><command>doxywizard</command></term>
260 <listitem>
261 <para>
262 is a GUI front-end for configuring and
263 running <command>doxygen</command>.
264 </para>
265 <indexterm zone="doxygen doxywizard">
266 <primary sortas="b-doxywizard">doxywizard</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="doxyindexer">
272 <term><command>doxyindexer</command></term>
273 <listitem>
274 <para>
275 generates a search index called <filename>doxysearch.db</filename>
276 from one or more search data files produced by
277 <command>doxygen</command>. See, e.g. <ulink
278 url="http://www.stack.nl/~dimitri/doxygen/manual/extsearch.html"/>.
279 </para>
280 <indexterm zone="doxygen doxyindexer">
281 <primary sortas="b-doxyindexer">doxyindexer</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="doxysearch.cgi">
287 <term><command>doxysearch.cgi</command></term>
288 <listitem>
289 <para>
290 is a CGI program to search the data indexed by
291 <command>doxyindexer</command>.
292 </para>
293 <indexterm zone="doxygen doxysearch.cgi">
294 <primary sortas="b-doxysearch.cgi">doxysearch.cgi</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 </variablelist>
300
301 </sect2>
302
303</sect1>
Note: See TracBrowser for help on using the repository browser.