source: general/prog/doxygen.xml@ 2e0d6b9

10.0 10.1 11.0 11.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 2e0d6b9 was 2e0d6b9, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Update sshfs instructions fo rmeson/ninja.
Tags and cleanup.

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