source: general/prog/doxygen.xml@ 372597e

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

Update to xvidcore-1.3.7.
Update to poppler-0.84.0.
Update to doxygen-1.8.17.
Update to ruby-2.7.0.
Update to NetworkManager-1.22.2.

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

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