[faa80ab] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[faa80ab] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[c6b192c] | 7 | <!ENTITY doxygen-download-http "https://doxygen.nl/files/doxygen-&doxygen-version;.src.tar.gz">
|
---|
[01f594b] | 8 | <!ENTITY doxygen-download-ftp " ">
|
---|
[5b75675] | 9 | <!ENTITY doxygen-md5sum "5e608271e39108728b2e408a14f2991a">
|
---|
| 10 | <!ENTITY doxygen-size "7.7 MB">
|
---|
| 11 | <!ENTITY doxygen-buildsize "246 MB (with tests)">
|
---|
| 12 | <!ENTITY doxygen-time "1.7 SBU (using parallelism=4; with tests)">
|
---|
[faa80ab] | 13 | ]>
|
---|
| 14 |
|
---|
[cef3a2f] | 15 | <sect1 id="doxygen" xreflabel="Doxygen-&doxygen-version;">
|
---|
[1bbef1e] | 16 | <?dbhtml filename="doxygen.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>Doxygen-&doxygen-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="doxygen">
|
---|
| 22 | <primary sortas="a-Doxygen">Doxygen</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Doxygen</title>
|
---|
| 27 |
|
---|
[8f1699f2] | 28 | <para>
|
---|
| 29 | The <application>Doxygen</application> package contains a documentation
|
---|
| 30 | system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP,
|
---|
| 31 | C# and D. It is useful for generating HTML documentation and/or an
|
---|
| 32 | off-line reference manual from a set of documented source files. There
|
---|
| 33 | is also support for generating output in RTF, PostScript, hyperlinked
|
---|
| 34 | PDF, compressed HTML, and Unix man pages. The documentation is extracted
|
---|
| 35 | directly from the sources, which makes it much easier to keep the
|
---|
| 36 | documentation consistent with the source code.
|
---|
| 37 | </para>
|
---|
| 38 |
|
---|
| 39 | <para>
|
---|
| 40 | You can also configure <application>Doxygen</application> to extract
|
---|
| 41 | the code structure from undocumented source files. This is very useful
|
---|
| 42 | to quickly find your way in large source distributions. Used along with
|
---|
| 43 | <application>Graphviz</application>, you can also visualize the relations
|
---|
| 44 | between the various elements by means of include dependency graphs,
|
---|
| 45 | inheritance diagrams, and collaboration diagrams, which are all generated
|
---|
| 46 | automatically.
|
---|
| 47 | </para>
|
---|
[1bbef1e] | 48 |
|
---|
[6156212c] | 49 | &lfs120_checked;
|
---|
[778be14] | 50 |
|
---|
[1bbef1e] | 51 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 52 | <itemizedlist spacing="compact">
|
---|
| 53 | <listitem>
|
---|
[8f1699f2] | 54 | <para>
|
---|
| 55 | Download (HTTP): <ulink url="&doxygen-download-http;"/>
|
---|
| 56 | </para>
|
---|
[1bbef1e] | 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[8f1699f2] | 59 | <para>
|
---|
| 60 | Download (FTP): <ulink url="&doxygen-download-ftp;"/>
|
---|
| 61 | </para>
|
---|
[1bbef1e] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[8f1699f2] | 64 | <para>
|
---|
| 65 | Download MD5 sum: &doxygen-md5sum;
|
---|
| 66 | </para>
|
---|
[1bbef1e] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[8f1699f2] | 69 | <para>
|
---|
| 70 | Download size: &doxygen-size;
|
---|
| 71 | </para>
|
---|
[1bbef1e] | 72 | </listitem>
|
---|
| 73 | <listitem>
|
---|
[8f1699f2] | 74 | <para>
|
---|
| 75 | Estimated disk space required: &doxygen-buildsize;
|
---|
| 76 | </para>
|
---|
[1bbef1e] | 77 | </listitem>
|
---|
| 78 | <listitem>
|
---|
[8f1699f2] | 79 | <para>
|
---|
| 80 | Estimated build time: &doxygen-time;
|
---|
| 81 | </para>
|
---|
[1bbef1e] | 82 | </listitem>
|
---|
| 83 | </itemizedlist>
|
---|
[13d0d6f0] | 84 | <!--
|
---|
[b4ea593] | 85 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 86 | <itemizedlist spacing='compact'>
|
---|
| 87 | <listitem>
|
---|
[de33b2a] | 88 | <para>
|
---|
| 89 | Required patch: <ulink
|
---|
| 90 | url="&patch-root;/doxygen-&doxygen-version;-flex_2_6_0_fix-1.patch"/>
|
---|
| 91 | </para>
|
---|
[b4ea593] | 92 | </listitem>
|
---|
[13d0d6f0] | 93 | </itemizedlist>-->
|
---|
| 94 |
|
---|
[1bbef1e] | 95 | <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
|
---|
| 96 |
|
---|
[42285880] | 97 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 98 | <para role="required">
|
---|
[3fb270d] | 99 | <xref linkend="cmake"/> and
|
---|
| 100 | <xref linkend="git"/>
|
---|
[42285880] | 101 | </para>
|
---|
| 102 |
|
---|
[1bbef1e] | 103 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[8f1699f2] | 104 | <para role="optional">
|
---|
| 105 | <xref linkend="graphviz"/>,
|
---|
| 106 | <xref linkend="gs"/>,
|
---|
[9e3d18a7] | 107 | <xref linkend="libxml2"/> (required for the tests),
|
---|
[75457cc] | 108 | <xref linkend="llvm"/> (with clang),
|
---|
[8b0496b] | 109 | <!-- Can someone check this? With LLVM7, it fails to build. -->
|
---|
[b3867c5] | 110 | &qt5-deps; (for doxywizard),
|
---|
[d5f6e8e] | 111 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
|
---|
| 112 | <xref linkend="xapian"/> (for doxyindexer), and
|
---|
| 113 | <ulink url="https://javacc.github.io/javacc/">javacc</ulink>
|
---|
[8f1699f2] | 114 | </para>
|
---|
[1bbef1e] | 115 |
|
---|
| 116 | </sect2>
|
---|
| 117 |
|
---|
| 118 | <sect2 role="installation">
|
---|
| 119 | <title>Installation of Doxygen</title>
|
---|
| 120 |
|
---|
[07efc98] | 121 | <note>
|
---|
| 122 | <para>
|
---|
| 123 | When untarring this package, you may see messages such as
|
---|
| 124 | <quote>Ignoring unknown extended header keyword 'LIBARCHIVE.xattr.com.apple.TextEncoding'</quote>.
|
---|
| 125 | These messages are harmless, and can be safely ignored.
|
---|
| 126 | </para>
|
---|
| 127 | </note>
|
---|
| 128 |
|
---|
[9629dab] | 129 | <para>
|
---|
| 130 | First, fix up some python scripts:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
| 133 | <screen><userinput>grep -rl '^#!.*python$' | xargs sed -i '1s/python/&3/'</userinput></screen>
|
---|
| 134 |
|
---|
[8f1699f2] | 135 | <para>
|
---|
| 136 | Install <application>Doxygen</application> by running the following
|
---|
| 137 | commands:
|
---|
| 138 | </para>
|
---|
[1bbef1e] | 139 |
|
---|
[c41843e] | 140 | <screen><userinput>mkdir -v build &&
|
---|
| 141 | cd build &&
|
---|
| 142 |
|
---|
| 143 | cmake -G "Unix Makefiles" \
|
---|
[42285880] | 144 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 145 | -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
[88499366] | 146 | -Wno-dev .. &&
|
---|
[42285880] | 147 |
|
---|
[1bbef1e] | 148 | make</userinput></screen>
|
---|
[d260aaf4] | 149 |
|
---|
[8f1699f2] | 150 | <para>
|
---|
[f2abc73] | 151 | To test the results, issue: <command>make tests</command>.
|
---|
[fe6657ba] | 152 | <!--One test, 012_cite.dox, is known to fail.-->
|
---|
[8f1699f2] | 153 | </para>
|
---|
[a1fd0f2] | 154 |
|
---|
[42285880] | 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 |
|
---|
[a42c273] | 162 | <screen remap="doc"><userinput>cmake -DDOC_INSTALL_DIR=share/doc/doxygen-&doxygen-version; -Dbuild_doc=ON .. &&
|
---|
[42285880] | 163 |
|
---|
| 164 | make docs</userinput></screen>
|
---|
| 165 |
|
---|
[8f1699f2] | 166 | <para>
|
---|
| 167 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 168 | </para>
|
---|
[d260aaf4] | 169 |
|
---|
[42285880] | 170 | <screen role="root"><userinput>make install &&
|
---|
[bd4f0143] | 171 | install -vm644 ../doc/*.1 /usr/share/man/man1</userinput></screen>
|
---|
[a1fd0f2] | 172 |
|
---|
[13d0d6f0] | 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 |
|
---|
[1bbef1e] | 179 | </sect2>
|
---|
| 180 |
|
---|
| 181 | <sect2 role="commands">
|
---|
| 182 | <title>Command Explanations</title>
|
---|
| 183 |
|
---|
[42285880] | 184 | <para>
|
---|
| 185 | <option>-Dbuild_wizard=ON</option>: Use this switch if
|
---|
[88499366] | 186 | <application>Qt5</application> is installed and you wish to build the GUI
|
---|
[42285880] | 187 | front-end.
|
---|
[8f1699f2] | 188 | </para>
|
---|
[1bbef1e] | 189 |
|
---|
[75457cc] | 190 | <para>
|
---|
[42285880] | 191 | <option>-Dbuild_search=ON</option>: Use this switch if
|
---|
[75457cc] | 192 | <application>xapian</application> is installed and you wish to build
|
---|
[38b3eab] | 193 | external search tools (<command>doxysearch.cgi</command> and
|
---|
| 194 | <command>doxyindexer)</command>.
|
---|
[75457cc] | 195 | </para>
|
---|
[88499366] | 196 | <!--
|
---|
[13d0d6f0] | 197 | <para>
|
---|
| 198 | <option>-Dforce_qt4=ON</option>: Use this switch to build
|
---|
| 199 | <command>doxywizard</command> with Qt4 even if Qt5 is installed.
|
---|
[88499366] | 200 | </para>-->
|
---|
[13d0d6f0] | 201 |
|
---|
[75457cc] | 202 | <para>
|
---|
[42285880] | 203 | <option>-Duse_libclang=ON</option>: Use this switch if
|
---|
[75457cc] | 204 | <application>llvm</application> with <application>clang</application> are
|
---|
[42285880] | 205 | installed, to add support for libclang parsing.
|
---|
| 206 | </para>
|
---|
| 207 |
|
---|
[a1fd0f2] | 208 | </sect2>
|
---|
[1bbef1e] | 209 |
|
---|
[a1fd0f2] | 210 | <sect2 role="configuration">
|
---|
| 211 | <title>Configuring Doxygen</title>
|
---|
[1bbef1e] | 212 |
|
---|
[8f1699f2] | 213 | <para>
|
---|
| 214 | There is no real configuration necessary for the
|
---|
| 215 | <application>Doxygen</application> package although three additional
|
---|
[2b676a5c] | 216 | packages are required if you wish to use extended capabilities.
|
---|
| 217 | If you require formulas to create PDF
|
---|
[8f1699f2] | 218 | documentation, then you must have <xref linkend="texlive"/> installed.
|
---|
| 219 | If you require formulas to convert PostScript files to bitmaps, then
|
---|
| 220 | you must have <xref linkend="gs"/> installed.
|
---|
| 221 | </para>
|
---|
[1bbef1e] | 222 |
|
---|
| 223 | </sect2>
|
---|
| 224 |
|
---|
| 225 | <sect2 role="content">
|
---|
| 226 | <title>Contents</title>
|
---|
| 227 |
|
---|
| 228 | <segmentedlist>
|
---|
| 229 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 230 | <segtitle>Installed Libraries</segtitle>
|
---|
[1bbef1e] | 231 | <segtitle>Installed Directory</segtitle>
|
---|
| 232 |
|
---|
| 233 | <seglistitem>
|
---|
[8f1699f2] | 234 | <seg>
|
---|
[75457cc] | 235 | doxygen and optionally,
|
---|
| 236 | doxywizard, doxyindexer and doxysearch.cgi
|
---|
[8f1699f2] | 237 | </seg>
|
---|
[c3c56b2] | 238 | <seg>
|
---|
| 239 | None
|
---|
| 240 | </seg>
|
---|
[8f1699f2] | 241 | <seg>
|
---|
| 242 | /usr/share/doc/doxygen-&doxygen-version;
|
---|
| 243 | </seg>
|
---|
[1bbef1e] | 244 | </seglistitem>
|
---|
| 245 | </segmentedlist>
|
---|
| 246 |
|
---|
| 247 | <variablelist>
|
---|
| 248 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 249 | <?dbfo list-presentation="list"?>
|
---|
| 250 | <?dbhtml list-presentation="table"?>
|
---|
| 251 |
|
---|
| 252 | <varlistentry id="doxygen-prog">
|
---|
| 253 | <term><command>doxygen</command></term>
|
---|
| 254 | <listitem>
|
---|
[8f1699f2] | 255 | <para>
|
---|
| 256 | is a command-line based utility used to generate template
|
---|
| 257 | configuration files and then generate documentation from these
|
---|
| 258 | templates. Use <command>doxygen --help</command> for an
|
---|
[4c24eb0a] | 259 | explanation of the command-line parameters
|
---|
[8f1699f2] | 260 | </para>
|
---|
[1bbef1e] | 261 | <indexterm zone="doxygen doxygen-prog">
|
---|
| 262 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
| 263 | </indexterm>
|
---|
| 264 | </listitem>
|
---|
| 265 | </varlistentry>
|
---|
| 266 |
|
---|
| 267 | <varlistentry id="doxywizard">
|
---|
| 268 | <term><command>doxywizard</command></term>
|
---|
| 269 | <listitem>
|
---|
[8f1699f2] | 270 | <para>
|
---|
| 271 | is a GUI front-end for configuring and
|
---|
[4c24eb0a] | 272 | running <command>doxygen</command>
|
---|
[8f1699f2] | 273 | </para>
|
---|
[1bbef1e] | 274 | <indexterm zone="doxygen doxywizard">
|
---|
| 275 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
| 276 | </indexterm>
|
---|
| 277 | </listitem>
|
---|
| 278 | </varlistentry>
|
---|
[8f1699f2] | 279 |
|
---|
[75457cc] | 280 | <varlistentry id="doxyindexer">
|
---|
| 281 | <term><command>doxyindexer</command></term>
|
---|
| 282 | <listitem>
|
---|
| 283 | <para>
|
---|
| 284 | generates a search index called <filename>doxysearch.db</filename>
|
---|
| 285 | from one or more search data files produced by
|
---|
[4c24eb0a] | 286 | <command>doxygen</command>. See, e.g.
|
---|
| 287 | <ulink url="https://javacc.github.io/javacc/"/>
|
---|
[75457cc] | 288 | </para>
|
---|
| 289 | <indexterm zone="doxygen doxyindexer">
|
---|
| 290 | <primary sortas="b-doxyindexer">doxyindexer</primary>
|
---|
| 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
| 294 |
|
---|
| 295 | <varlistentry id="doxysearch.cgi">
|
---|
| 296 | <term><command>doxysearch.cgi</command></term>
|
---|
| 297 | <listitem>
|
---|
| 298 | <para>
|
---|
| 299 | is a CGI program to search the data indexed by
|
---|
[4c24eb0a] | 300 | <command>doxyindexer</command>
|
---|
[75457cc] | 301 | </para>
|
---|
| 302 | <indexterm zone="doxygen doxysearch.cgi">
|
---|
| 303 | <primary sortas="b-doxysearch.cgi">doxysearch.cgi</primary>
|
---|
| 304 | </indexterm>
|
---|
| 305 | </listitem>
|
---|
| 306 | </varlistentry>
|
---|
| 307 |
|
---|
[1bbef1e] | 308 | </variablelist>
|
---|
| 309 |
|
---|
| 310 | </sect2>
|
---|
[faa80ab] | 311 |
|
---|
| 312 | </sect1>
|
---|