[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 " ">
|
---|
[7a5e58b] | 9 | <!ENTITY doxygen-md5sum "5f7ab15c8298d013c5ef205a4febc7b4">
|
---|
| 10 | <!ENTITY doxygen-size "5.1 MB">
|
---|
| 11 | <!ENTITY doxygen-buildsize "217 MB (with tests)">
|
---|
[ef280b81] | 12 | <!ENTITY doxygen-time "1.4 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 |
|
---|
[b984aaa1] | 49 | &lfs112_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. -->
|
---|
[60ddbaf] | 110 | <xref linkend="python2"/>,
|
---|
[13d0d6f0] | 111 | <xref linkend="qt5"/> (for doxywizard),
|
---|
[d5f6e8e] | 112 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
|
---|
| 113 | <xref linkend="xapian"/> (for doxyindexer), and
|
---|
| 114 | <ulink url="https://javacc.github.io/javacc/">javacc</ulink>
|
---|
[8f1699f2] | 115 | </para>
|
---|
[1bbef1e] | 116 |
|
---|
[1039de3] | 117 | <para condition="html" role="usernotes">User Notes:
|
---|
[8f1699f2] | 118 | <ulink url="&blfs-wiki;/doxygen"/>
|
---|
| 119 | </para>
|
---|
[1bbef1e] | 120 | </sect2>
|
---|
| 121 |
|
---|
| 122 | <sect2 role="installation">
|
---|
| 123 | <title>Installation of Doxygen</title>
|
---|
| 124 |
|
---|
[8f1699f2] | 125 | <para>
|
---|
| 126 | Install <application>Doxygen</application> by running the following
|
---|
| 127 | commands:
|
---|
| 128 | </para>
|
---|
[1bbef1e] | 129 |
|
---|
[c41843e] | 130 | <screen><userinput>mkdir -v build &&
|
---|
| 131 | cd build &&
|
---|
| 132 |
|
---|
| 133 | cmake -G "Unix Makefiles" \
|
---|
[42285880] | 134 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 135 | -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
[88499366] | 136 | -Wno-dev .. &&
|
---|
[42285880] | 137 |
|
---|
[1bbef1e] | 138 | make</userinput></screen>
|
---|
[d260aaf4] | 139 |
|
---|
[8f1699f2] | 140 | <para>
|
---|
[f2abc73] | 141 | To test the results, issue: <command>make tests</command>.
|
---|
[b11b268] | 142 | <!--One test, 012_cite.dox, is known to fail.-->
|
---|
[8f1699f2] | 143 | </para>
|
---|
[a1fd0f2] | 144 |
|
---|
[42285880] | 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 |
|
---|
[a42c273] | 152 | <screen remap="doc"><userinput>cmake -DDOC_INSTALL_DIR=share/doc/doxygen-&doxygen-version; -Dbuild_doc=ON .. &&
|
---|
[42285880] | 153 |
|
---|
| 154 | make docs</userinput></screen>
|
---|
| 155 |
|
---|
[8f1699f2] | 156 | <para>
|
---|
| 157 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 158 | </para>
|
---|
[d260aaf4] | 159 |
|
---|
[42285880] | 160 | <screen role="root"><userinput>make install &&
|
---|
[bd4f0143] | 161 | install -vm644 ../doc/*.1 /usr/share/man/man1</userinput></screen>
|
---|
[a1fd0f2] | 162 |
|
---|
[13d0d6f0] | 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 |
|
---|
[1bbef1e] | 169 | </sect2>
|
---|
| 170 |
|
---|
| 171 | <sect2 role="commands">
|
---|
| 172 | <title>Command Explanations</title>
|
---|
| 173 |
|
---|
[42285880] | 174 | <para>
|
---|
| 175 | <option>-Dbuild_wizard=ON</option>: Use this switch if
|
---|
[88499366] | 176 | <application>Qt5</application> is installed and you wish to build the GUI
|
---|
[42285880] | 177 | front-end.
|
---|
[8f1699f2] | 178 | </para>
|
---|
[1bbef1e] | 179 |
|
---|
[75457cc] | 180 | <para>
|
---|
[42285880] | 181 | <option>-Dbuild_search=ON</option>: Use this switch if
|
---|
[75457cc] | 182 | <application>xapian</application> is installed and you wish to build
|
---|
[38b3eab] | 183 | external search tools (<command>doxysearch.cgi</command> and
|
---|
| 184 | <command>doxyindexer)</command>.
|
---|
[75457cc] | 185 | </para>
|
---|
[88499366] | 186 | <!--
|
---|
[13d0d6f0] | 187 | <para>
|
---|
| 188 | <option>-Dforce_qt4=ON</option>: Use this switch to build
|
---|
| 189 | <command>doxywizard</command> with Qt4 even if Qt5 is installed.
|
---|
[88499366] | 190 | </para>-->
|
---|
[13d0d6f0] | 191 |
|
---|
[75457cc] | 192 | <para>
|
---|
[42285880] | 193 | <option>-Duse_libclang=ON</option>: Use this switch if
|
---|
[75457cc] | 194 | <application>llvm</application> with <application>clang</application> are
|
---|
[42285880] | 195 | installed, to add support for libclang parsing.
|
---|
| 196 | </para>
|
---|
| 197 |
|
---|
[a1fd0f2] | 198 | </sect2>
|
---|
[1bbef1e] | 199 |
|
---|
[a1fd0f2] | 200 | <sect2 role="configuration">
|
---|
| 201 | <title>Configuring Doxygen</title>
|
---|
[1bbef1e] | 202 |
|
---|
[8f1699f2] | 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>
|
---|
[1bbef1e] | 213 |
|
---|
| 214 | </sect2>
|
---|
| 215 |
|
---|
| 216 | <sect2 role="content">
|
---|
| 217 | <title>Contents</title>
|
---|
| 218 |
|
---|
| 219 | <segmentedlist>
|
---|
| 220 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 221 | <segtitle>Installed Libraries</segtitle>
|
---|
[1bbef1e] | 222 | <segtitle>Installed Directory</segtitle>
|
---|
| 223 |
|
---|
| 224 | <seglistitem>
|
---|
[8f1699f2] | 225 | <seg>
|
---|
[75457cc] | 226 | doxygen and optionally,
|
---|
| 227 | doxywizard, doxyindexer and doxysearch.cgi
|
---|
[8f1699f2] | 228 | </seg>
|
---|
[c3c56b2] | 229 | <seg>
|
---|
| 230 | None
|
---|
| 231 | </seg>
|
---|
[8f1699f2] | 232 | <seg>
|
---|
| 233 | /usr/share/doc/doxygen-&doxygen-version;
|
---|
| 234 | </seg>
|
---|
[1bbef1e] | 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>
|
---|
[8f1699f2] | 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
|
---|
[4c24eb0a] | 250 | explanation of the command-line parameters
|
---|
[8f1699f2] | 251 | </para>
|
---|
[1bbef1e] | 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>
|
---|
[8f1699f2] | 261 | <para>
|
---|
| 262 | is a GUI front-end for configuring and
|
---|
[4c24eb0a] | 263 | running <command>doxygen</command>
|
---|
[8f1699f2] | 264 | </para>
|
---|
[1bbef1e] | 265 | <indexterm zone="doxygen doxywizard">
|
---|
| 266 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
| 267 | </indexterm>
|
---|
| 268 | </listitem>
|
---|
| 269 | </varlistentry>
|
---|
[8f1699f2] | 270 |
|
---|
[75457cc] | 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
|
---|
[4c24eb0a] | 277 | <command>doxygen</command>. See, e.g.
|
---|
| 278 | <ulink url="https://javacc.github.io/javacc/"/>
|
---|
[75457cc] | 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
|
---|
[4c24eb0a] | 291 | <command>doxyindexer</command>
|
---|
[75457cc] | 292 | </para>
|
---|
| 293 | <indexterm zone="doxygen doxysearch.cgi">
|
---|
| 294 | <primary sortas="b-doxysearch.cgi">doxysearch.cgi</primary>
|
---|
| 295 | </indexterm>
|
---|
| 296 | </listitem>
|
---|
| 297 | </varlistentry>
|
---|
| 298 |
|
---|
[1bbef1e] | 299 | </variablelist>
|
---|
| 300 |
|
---|
| 301 | </sect2>
|
---|
[faa80ab] | 302 |
|
---|
| 303 | </sect1>
|
---|