[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 |
|
---|
[01f594b] | 7 | <!ENTITY doxygen-download-http "http://doxygen.nl/files/doxygen-&doxygen-version;.src.tar.gz">
|
---|
| 8 | <!ENTITY doxygen-download-ftp " ">
|
---|
[d5f6e8e] | 9 | <!ENTITY doxygen-md5sum "1513a1f6c0003dcf1d840e0420953857">
|
---|
[372597e] | 10 | <!ENTITY doxygen-size "4.9 MB">
|
---|
[d5f6e8e] | 11 | <!ENTITY doxygen-buildsize "177 MB (with tests)">
|
---|
| 12 | <!ENTITY doxygen-time "1.1 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 | <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 |
|
---|
[8f1699f2] | 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>
|
---|
[1bbef1e] | 52 |
|
---|
[18a8da63] | 53 | &lfs10_checked;
|
---|
[778be14] | 54 |
|
---|
[1bbef1e] | 55 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 56 | <itemizedlist spacing="compact">
|
---|
| 57 | <listitem>
|
---|
[8f1699f2] | 58 | <para>
|
---|
| 59 | Download (HTTP): <ulink url="&doxygen-download-http;"/>
|
---|
| 60 | </para>
|
---|
[1bbef1e] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[8f1699f2] | 63 | <para>
|
---|
| 64 | Download (FTP): <ulink url="&doxygen-download-ftp;"/>
|
---|
| 65 | </para>
|
---|
[1bbef1e] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[8f1699f2] | 68 | <para>
|
---|
| 69 | Download MD5 sum: &doxygen-md5sum;
|
---|
| 70 | </para>
|
---|
[1bbef1e] | 71 | </listitem>
|
---|
| 72 | <listitem>
|
---|
[8f1699f2] | 73 | <para>
|
---|
| 74 | Download size: &doxygen-size;
|
---|
| 75 | </para>
|
---|
[1bbef1e] | 76 | </listitem>
|
---|
| 77 | <listitem>
|
---|
[8f1699f2] | 78 | <para>
|
---|
| 79 | Estimated disk space required: &doxygen-buildsize;
|
---|
| 80 | </para>
|
---|
[1bbef1e] | 81 | </listitem>
|
---|
| 82 | <listitem>
|
---|
[8f1699f2] | 83 | <para>
|
---|
| 84 | Estimated build time: &doxygen-time;
|
---|
| 85 | </para>
|
---|
[1bbef1e] | 86 | </listitem>
|
---|
| 87 | </itemizedlist>
|
---|
[13d0d6f0] | 88 | <!--
|
---|
[b4ea593] | 89 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 90 | <itemizedlist spacing='compact'>
|
---|
| 91 | <listitem>
|
---|
[de33b2a] | 92 | <para>
|
---|
| 93 | Required patch: <ulink
|
---|
| 94 | url="&patch-root;/doxygen-&doxygen-version;-flex_2_6_0_fix-1.patch"/>
|
---|
| 95 | </para>
|
---|
[b4ea593] | 96 | </listitem>
|
---|
[13d0d6f0] | 97 | </itemizedlist>-->
|
---|
| 98 |
|
---|
[1bbef1e] | 99 | <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
|
---|
| 100 |
|
---|
[42285880] | 101 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 102 | <para role="required">
|
---|
[3fb270d] | 103 | <xref linkend="cmake"/> and
|
---|
| 104 | <xref linkend="git"/>
|
---|
[42285880] | 105 | </para>
|
---|
| 106 |
|
---|
[1bbef1e] | 107 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[8f1699f2] | 108 | <para role="optional">
|
---|
| 109 | <xref linkend="graphviz"/>,
|
---|
| 110 | <xref linkend="gs"/>,
|
---|
[9e3d18a7] | 111 | <xref linkend="libxml2"/> (required for the tests),
|
---|
[75457cc] | 112 | <xref linkend="llvm"/> (with clang),
|
---|
[8b0496b] | 113 | <!-- Can someone check this? With LLVM7, it fails to build. -->
|
---|
[60ddbaf] | 114 | <xref linkend="python2"/>,
|
---|
[13d0d6f0] | 115 | <xref linkend="qt5"/> (for doxywizard),
|
---|
[d5f6e8e] | 116 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
|
---|
| 117 | <xref linkend="xapian"/> (for doxyindexer), and
|
---|
| 118 | <ulink url="https://javacc.github.io/javacc/">javacc</ulink>
|
---|
[8f1699f2] | 119 | </para>
|
---|
[1bbef1e] | 120 |
|
---|
[1039de3] | 121 | <para condition="html" role="usernotes">User Notes:
|
---|
[8f1699f2] | 122 | <ulink url="&blfs-wiki;/doxygen"/>
|
---|
| 123 | </para>
|
---|
[1bbef1e] | 124 | </sect2>
|
---|
| 125 |
|
---|
| 126 | <sect2 role="installation">
|
---|
| 127 | <title>Installation of Doxygen</title>
|
---|
| 128 |
|
---|
[8f1699f2] | 129 | <para>
|
---|
| 130 | Install <application>Doxygen</application> by running the following
|
---|
| 131 | commands:
|
---|
| 132 | </para>
|
---|
[1bbef1e] | 133 |
|
---|
[c41843e] | 134 | <screen><userinput>mkdir -v build &&
|
---|
| 135 | cd build &&
|
---|
| 136 |
|
---|
| 137 | cmake -G "Unix Makefiles" \
|
---|
[42285880] | 138 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 139 | -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
[88499366] | 140 | -Wno-dev .. &&
|
---|
[42285880] | 141 |
|
---|
[1bbef1e] | 142 | make</userinput></screen>
|
---|
[d260aaf4] | 143 |
|
---|
[8f1699f2] | 144 | <para>
|
---|
[f2abc73] | 145 | To test the results, issue: <command>make tests</command>.
|
---|
[8f1699f2] | 146 | </para>
|
---|
[a1fd0f2] | 147 |
|
---|
[42285880] | 148 | <para>
|
---|
| 149 | If you wish to generate the package documentation, you must have
|
---|
| 150 | <application>Python</application>, <application>TeX Live</application>
|
---|
| 151 | (for HTML docs) and <application>Ghostscript</application> (for PDF docs)
|
---|
| 152 | installed, then issue the following command:
|
---|
| 153 | </para>
|
---|
| 154 |
|
---|
[a42c273] | 155 | <screen remap="doc"><userinput>cmake -DDOC_INSTALL_DIR=share/doc/doxygen-&doxygen-version; -Dbuild_doc=ON .. &&
|
---|
[42285880] | 156 |
|
---|
| 157 | make docs</userinput></screen>
|
---|
| 158 |
|
---|
[8f1699f2] | 159 | <para>
|
---|
| 160 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 161 | </para>
|
---|
[d260aaf4] | 162 |
|
---|
[42285880] | 163 | <screen role="root"><userinput>make install &&
|
---|
[bd4f0143] | 164 | install -vm644 ../doc/*.1 /usr/share/man/man1</userinput></screen>
|
---|
[a1fd0f2] | 165 |
|
---|
[13d0d6f0] | 166 | <para>
|
---|
| 167 | If you have generated the package documentation, then the man pages are
|
---|
| 168 | automatically installed, and you do not need to run the last
|
---|
| 169 | <command>install ...</command> command.
|
---|
| 170 | </para>
|
---|
| 171 |
|
---|
[1bbef1e] | 172 | </sect2>
|
---|
| 173 |
|
---|
| 174 | <sect2 role="commands">
|
---|
| 175 | <title>Command Explanations</title>
|
---|
| 176 |
|
---|
[42285880] | 177 | <para>
|
---|
| 178 | <option>-Dbuild_wizard=ON</option>: Use this switch if
|
---|
[88499366] | 179 | <application>Qt5</application> is installed and you wish to build the GUI
|
---|
[42285880] | 180 | front-end.
|
---|
[8f1699f2] | 181 | </para>
|
---|
[1bbef1e] | 182 |
|
---|
[75457cc] | 183 | <para>
|
---|
[42285880] | 184 | <option>-Dbuild_search=ON</option>: Use this switch if
|
---|
[75457cc] | 185 | <application>xapian</application> is installed and you wish to build
|
---|
[38b3eab] | 186 | external search tools (<command>doxysearch.cgi</command> and
|
---|
| 187 | <command>doxyindexer)</command>.
|
---|
[75457cc] | 188 | </para>
|
---|
[88499366] | 189 | <!--
|
---|
[13d0d6f0] | 190 | <para>
|
---|
| 191 | <option>-Dforce_qt4=ON</option>: Use this switch to build
|
---|
| 192 | <command>doxywizard</command> with Qt4 even if Qt5 is installed.
|
---|
[88499366] | 193 | </para>-->
|
---|
[13d0d6f0] | 194 |
|
---|
[75457cc] | 195 | <para>
|
---|
[42285880] | 196 | <option>-Duse_libclang=ON</option>: Use this switch if
|
---|
[75457cc] | 197 | <application>llvm</application> with <application>clang</application> are
|
---|
[42285880] | 198 | installed, to add support for libclang parsing.
|
---|
| 199 | </para>
|
---|
| 200 |
|
---|
[a1fd0f2] | 201 | </sect2>
|
---|
[1bbef1e] | 202 |
|
---|
[a1fd0f2] | 203 | <sect2 role="configuration">
|
---|
| 204 | <title>Configuring Doxygen</title>
|
---|
[1bbef1e] | 205 |
|
---|
[8f1699f2] | 206 | <para>
|
---|
| 207 | There is no real configuration necessary for the
|
---|
| 208 | <application>Doxygen</application> package although three additional
|
---|
| 209 | packages are required if you wish to use extended capabilities. If you
|
---|
| 210 | need to use the language translation features, you must have <xref
|
---|
| 211 | linkend="python2"/> installed. If you require formulas to create PDF
|
---|
| 212 | documentation, then you must have <xref linkend="texlive"/> installed.
|
---|
| 213 | If you require formulas to convert PostScript files to bitmaps, then
|
---|
| 214 | you must have <xref linkend="gs"/> installed.
|
---|
| 215 | </para>
|
---|
[1bbef1e] | 216 |
|
---|
| 217 | </sect2>
|
---|
| 218 |
|
---|
| 219 | <sect2 role="content">
|
---|
| 220 | <title>Contents</title>
|
---|
| 221 |
|
---|
| 222 | <segmentedlist>
|
---|
| 223 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 224 | <segtitle>Installed Libraries</segtitle>
|
---|
[1bbef1e] | 225 | <segtitle>Installed Directory</segtitle>
|
---|
| 226 |
|
---|
| 227 | <seglistitem>
|
---|
[8f1699f2] | 228 | <seg>
|
---|
[75457cc] | 229 | doxygen and optionally,
|
---|
| 230 | doxywizard, doxyindexer and doxysearch.cgi
|
---|
[8f1699f2] | 231 | </seg>
|
---|
[c3c56b2] | 232 | <seg>
|
---|
| 233 | None
|
---|
| 234 | </seg>
|
---|
[8f1699f2] | 235 | <seg>
|
---|
| 236 | /usr/share/doc/doxygen-&doxygen-version;
|
---|
| 237 | </seg>
|
---|
[1bbef1e] | 238 | </seglistitem>
|
---|
| 239 | </segmentedlist>
|
---|
| 240 |
|
---|
| 241 | <variablelist>
|
---|
| 242 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 243 | <?dbfo list-presentation="list"?>
|
---|
| 244 | <?dbhtml list-presentation="table"?>
|
---|
| 245 |
|
---|
| 246 | <varlistentry id="doxygen-prog">
|
---|
| 247 | <term><command>doxygen</command></term>
|
---|
| 248 | <listitem>
|
---|
[8f1699f2] | 249 | <para>
|
---|
| 250 | is a command-line based utility used to generate template
|
---|
| 251 | configuration files and then generate documentation from these
|
---|
| 252 | templates. Use <command>doxygen --help</command> for an
|
---|
| 253 | explanation of the command-line parameters.
|
---|
| 254 | </para>
|
---|
[1bbef1e] | 255 | <indexterm zone="doxygen doxygen-prog">
|
---|
| 256 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
| 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
| 260 |
|
---|
| 261 | <varlistentry id="doxywizard">
|
---|
| 262 | <term><command>doxywizard</command></term>
|
---|
| 263 | <listitem>
|
---|
[8f1699f2] | 264 | <para>
|
---|
| 265 | is a GUI front-end for configuring and
|
---|
| 266 | running <command>doxygen</command>.
|
---|
| 267 | </para>
|
---|
[1bbef1e] | 268 | <indexterm zone="doxygen doxywizard">
|
---|
| 269 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
| 270 | </indexterm>
|
---|
| 271 | </listitem>
|
---|
| 272 | </varlistentry>
|
---|
[8f1699f2] | 273 |
|
---|
[75457cc] | 274 | <varlistentry id="doxyindexer">
|
---|
| 275 | <term><command>doxyindexer</command></term>
|
---|
| 276 | <listitem>
|
---|
| 277 | <para>
|
---|
| 278 | generates a search index called <filename>doxysearch.db</filename>
|
---|
| 279 | from one or more search data files produced by
|
---|
| 280 | <command>doxygen</command>. See, e.g. <ulink
|
---|
[d5f6e8e] | 281 | url="https://javacc.github.io/javacc/"/>.
|
---|
[75457cc] | 282 | </para>
|
---|
| 283 | <indexterm zone="doxygen doxyindexer">
|
---|
| 284 | <primary sortas="b-doxyindexer">doxyindexer</primary>
|
---|
| 285 | </indexterm>
|
---|
| 286 | </listitem>
|
---|
| 287 | </varlistentry>
|
---|
| 288 |
|
---|
| 289 | <varlistentry id="doxysearch.cgi">
|
---|
| 290 | <term><command>doxysearch.cgi</command></term>
|
---|
| 291 | <listitem>
|
---|
| 292 | <para>
|
---|
| 293 | is a CGI program to search the data indexed by
|
---|
| 294 | <command>doxyindexer</command>.
|
---|
| 295 | </para>
|
---|
| 296 | <indexterm zone="doxygen doxysearch.cgi">
|
---|
| 297 | <primary sortas="b-doxysearch.cgi">doxysearch.cgi</primary>
|
---|
| 298 | </indexterm>
|
---|
| 299 | </listitem>
|
---|
| 300 | </varlistentry>
|
---|
| 301 |
|
---|
[1bbef1e] | 302 | </variablelist>
|
---|
| 303 |
|
---|
| 304 | </sect2>
|
---|
[faa80ab] | 305 |
|
---|
| 306 | </sect1>
|
---|