source: general/prog/doxygen.xml@ 77e379e

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 77e379e was 77e379e, checked in by Bruce Dubbs <bdubbs@…>, 16 months ago

Update to doxygen-1.9.2.wq

  • Property mode set to 100644
File size: 10.0 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 "https://doxygen.nl/files/doxygen-&doxygen-version;.src.tar.gz">
8 <!ENTITY doxygen-download-ftp " ">
9 <!ENTITY doxygen-md5sum "84c0522bb65d17f9127896268b72ea2a">
10 <!ENTITY doxygen-size "4.8 MB">
11 <!ENTITY doxygen-buildsize "165 MB (with tests)">
12 <!ENTITY doxygen-time "1.2 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 <date>$Date$</date>
20 </sect1info>
21
22 <title>Doxygen-&doxygen-version;</title>
23
24 <indexterm zone="doxygen">
25 <primary sortas="a-Doxygen">Doxygen</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Doxygen</title>
30
31 <para>
32 The <application>Doxygen</application> package contains a documentation
33 system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP,
34 C# and D. It is useful for generating HTML documentation and/or an
35 off-line reference manual from a set of documented source files. There
36 is also support for generating output in RTF, PostScript, hyperlinked
37 PDF, compressed HTML, and Unix man pages. The documentation is extracted
38 directly from the sources, which makes it much easier to keep the
39 documentation consistent with the source code.
40 </para>
41
42 <para>
43 You can also configure <application>Doxygen</application> to extract
44 the code structure from undocumented source files. This is very useful
45 to quickly find your way in large source distributions. Used along with
46 <application>Graphviz</application>, you can also visualize the relations
47 between the various elements by means of include dependency graphs,
48 inheritance diagrams, and collaboration diagrams, which are all generated
49 automatically.
50 </para>
51
52 &lfs110a_checked;
53
54 <bridgehead renderas="sect3">Package Information</bridgehead>
55 <itemizedlist spacing="compact">
56 <listitem>
57 <para>
58 Download (HTTP): <ulink url="&doxygen-download-http;"/>
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download (FTP): <ulink url="&doxygen-download-ftp;"/>
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Download MD5 sum: &doxygen-md5sum;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Download size: &doxygen-size;
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 Estimated disk space required: &doxygen-buildsize;
79 </para>
80 </listitem>
81 <listitem>
82 <para>
83 Estimated build time: &doxygen-time;
84 </para>
85 </listitem>
86 </itemizedlist>
87<!--
88 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
89 <itemizedlist spacing='compact'>
90 <listitem>
91 <para>
92 Required patch: <ulink
93 url="&patch-root;/doxygen-&doxygen-version;-flex_2_6_0_fix-1.patch"/>
94 </para>
95 </listitem>
96 </itemizedlist>-->
97
98 <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
99
100 <bridgehead renderas="sect4">Required</bridgehead>
101 <para role="required">
102 <xref linkend="cmake"/> and
103 <xref linkend="git"/>
104 </para>
105
106 <bridgehead renderas="sect4">Optional</bridgehead>
107 <para role="optional">
108 <xref linkend="graphviz"/>,
109 <xref linkend="gs"/>,
110 <xref linkend="libxml2"/> (required for the tests),
111 <xref linkend="llvm"/> (with clang),
112 <!-- Can someone check this? With LLVM7, it fails to build. -->
113 <xref linkend="python2"/>,
114 <xref linkend="qt5"/> (for doxywizard),
115 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
116 <xref linkend="xapian"/> (for doxyindexer), and
117 <ulink url="https://javacc.github.io/javacc/">javacc</ulink>
118 </para>
119
120 <para condition="html" role="usernotes">User Notes:
121 <ulink url="&blfs-wiki;/doxygen"/>
122 </para>
123 </sect2>
124
125 <sect2 role="installation">
126 <title>Installation of Doxygen</title>
127
128<!-- hopefully should be only needed for 1.9.1 -->
129 <para>
130 Remove a spurious file that prevents building the documentation:
131 </para>
132
133<screen><userinput>rm src/._xmlgen.cpp</userinput></screen>
134
135 <para>
136 Install <application>Doxygen</application> by running the following
137 commands:
138 </para>
139
140<screen><userinput>mkdir -v build &amp;&amp;
141cd build &amp;&amp;
142
143cmake -G "Unix Makefiles" \
144 -DCMAKE_BUILD_TYPE=Release \
145 -DCMAKE_INSTALL_PREFIX=/usr \
146 -Wno-dev .. &amp;&amp;
147
148make</userinput></screen>
149
150 <para>
151 To test the results, issue: <command>make tests</command>.
152 One test, 012_cite.dox, is known to fail.
153 </para>
154
155 <para>
156 If you wish to generate the package documentation, you must have
157 <application>Python</application>, <application>TeX Live</application>
158 (for HTML docs) and <application>Ghostscript</application> (for PDF docs)
159 installed, then issue the following command:
160 </para>
161
162<screen remap="doc"><userinput>cmake -DDOC_INSTALL_DIR=share/doc/doxygen-&doxygen-version; -Dbuild_doc=ON .. &amp;&amp;
163
164make docs</userinput></screen>
165
166 <para>
167 Now, as the <systemitem class="username">root</systemitem> user:
168 </para>
169
170<screen role="root"><userinput>make install &amp;&amp;
171install -vm644 ../doc/*.1 /usr/share/man/man1</userinput></screen>
172
173 <para>
174 If you have generated the package documentation, then the man pages are
175 automatically installed, and you do not need to run the last
176 <command>install ...</command> command.
177 </para>
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para>
185 <option>-Dbuild_wizard=ON</option>: Use this switch if
186 <application>Qt5</application> is installed and you wish to build the GUI
187 front-end.
188 </para>
189
190 <para>
191 <option>-Dbuild_search=ON</option>: Use this switch if
192 <application>xapian</application> is installed and you wish to build
193 external search tools (<command>doxysearch.cgi</command> and
194 <command>doxyindexer)</command>.
195 </para>
196<!--
197 <para>
198 <option>-Dforce_qt4=ON</option>: Use this switch to build
199 <command>doxywizard</command> with Qt4 even if Qt5 is installed.
200 </para>-->
201
202 <para>
203 <option>-Duse_libclang=ON</option>: Use this switch if
204 <application>llvm</application> with <application>clang</application> are
205 installed, to add support for libclang parsing.
206 </para>
207
208 </sect2>
209
210 <sect2 role="configuration">
211 <title>Configuring Doxygen</title>
212
213 <para>
214 There is no real configuration necessary for the
215 <application>Doxygen</application> package although three additional
216 packages are required if you wish to use extended capabilities. If you
217 need to use the language translation features, you must have <xref
218 linkend="python2"/> installed. If you require formulas to create PDF
219 documentation, then you must have <xref linkend="texlive"/> installed.
220 If you require formulas to convert PostScript files to bitmaps, then
221 you must have <xref linkend="gs"/> installed.
222 </para>
223
224 </sect2>
225
226 <sect2 role="content">
227 <title>Contents</title>
228
229 <segmentedlist>
230 <segtitle>Installed Programs</segtitle>
231 <segtitle>Installed Libraries</segtitle>
232 <segtitle>Installed Directory</segtitle>
233
234 <seglistitem>
235 <seg>
236 doxygen and optionally,
237 doxywizard, doxyindexer and doxysearch.cgi
238 </seg>
239 <seg>
240 None
241 </seg>
242 <seg>
243 /usr/share/doc/doxygen-&doxygen-version;
244 </seg>
245 </seglistitem>
246 </segmentedlist>
247
248 <variablelist>
249 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
250 <?dbfo list-presentation="list"?>
251 <?dbhtml list-presentation="table"?>
252
253 <varlistentry id="doxygen-prog">
254 <term><command>doxygen</command></term>
255 <listitem>
256 <para>
257 is a command-line based utility used to generate template
258 configuration files and then generate documentation from these
259 templates. Use <command>doxygen --help</command> for an
260 explanation of the command-line parameters
261 </para>
262 <indexterm zone="doxygen doxygen-prog">
263 <primary sortas="b-doxygen">doxygen</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="doxywizard">
269 <term><command>doxywizard</command></term>
270 <listitem>
271 <para>
272 is a GUI front-end for configuring and
273 running <command>doxygen</command>
274 </para>
275 <indexterm zone="doxygen doxywizard">
276 <primary sortas="b-doxywizard">doxywizard</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="doxyindexer">
282 <term><command>doxyindexer</command></term>
283 <listitem>
284 <para>
285 generates a search index called <filename>doxysearch.db</filename>
286 from one or more search data files produced by
287 <command>doxygen</command>. See, e.g.
288 <ulink url="https://javacc.github.io/javacc/"/>
289 </para>
290 <indexterm zone="doxygen doxyindexer">
291 <primary sortas="b-doxyindexer">doxyindexer</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="doxysearch.cgi">
297 <term><command>doxysearch.cgi</command></term>
298 <listitem>
299 <para>
300 is a CGI program to search the data indexed by
301 <command>doxyindexer</command>
302 </para>
303 <indexterm zone="doxygen doxysearch.cgi">
304 <primary sortas="b-doxysearch.cgi">doxysearch.cgi</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 </variablelist>
310
311 </sect2>
312
313</sect1>
Note: See TracBrowser for help on using the repository browser.