[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 |
|
---|
[778be14] | 7 | <!ENTITY doxygen-download-http "http://ftp.stack.nl/pub/doxygen/doxygen-&doxygen-version;.src.tar.gz">
|
---|
| 8 | <!ENTITY doxygen-download-ftp "ftp://ftp.stack.nl/pub/doxygen/doxygen-&doxygen-version;.src.tar.gz">
|
---|
[8770a48] | 9 | <!ENTITY doxygen-md5sum "79767ccd986f12a0f949015efb5f058f">
|
---|
| 10 | <!ENTITY doxygen-size "4.6 MB">
|
---|
| 11 | <!ENTITY doxygen-buildsize "174 MB (with all programs, docs, and tests)">
|
---|
| 12 | <!ENTITY doxygen-time "2.7 SBU (with all programs, docs, and 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 |
|
---|
[ac38e9dc] | 53 | &lfs77_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>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
|
---|
| 90 |
|
---|
[8770a48] | 91 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 92 | <para role="required">
|
---|
| 93 | <xref linkend="cmake"/>
|
---|
| 94 | </para>
|
---|
| 95 |
|
---|
[1bbef1e] | 96 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[8f1699f2] | 97 | <para role="optional">
|
---|
| 98 | <xref linkend="graphviz"/>,
|
---|
| 99 | <xref linkend="gs"/>,
|
---|
[8770a48] | 100 | <xref linkend="libxml2"/>,
|
---|
[ac38e9dc] | 101 | <xref linkend="llvm"/> (with clang),
|
---|
| 102 | <xref linkend="python2"/> or <xref linkend="python3"/>,
|
---|
| 103 | <xref linkend="qt4"/> (for doxywizard),
|
---|
| 104 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>) and
|
---|
| 105 | <xref linkend="xapian"/> (for doxyindexer)
|
---|
[8f1699f2] | 106 | </para>
|
---|
[1bbef1e] | 107 |
|
---|
[1039de3] | 108 | <para condition="html" role="usernotes">User Notes:
|
---|
[8f1699f2] | 109 | <ulink url="&blfs-wiki;/doxygen"/>
|
---|
| 110 | </para>
|
---|
[1bbef1e] | 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | <sect2 role="installation">
|
---|
| 114 | <title>Installation of Doxygen</title>
|
---|
| 115 |
|
---|
[8f1699f2] | 116 | <para>
|
---|
| 117 | Install <application>Doxygen</application> by running the following
|
---|
| 118 | commands:
|
---|
| 119 | </para>
|
---|
[1bbef1e] | 120 |
|
---|
[8770a48] | 121 | <screen><userinput>mkdir -v build &&
|
---|
| 122 | cd build &&
|
---|
| 123 | cmake -G "Unix Makefiles" \
|
---|
| 124 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 125 | -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 126 | .. & &
|
---|
| 127 |
|
---|
[1bbef1e] | 128 | make</userinput></screen>
|
---|
[d260aaf4] | 129 |
|
---|
[8f1699f2] | 130 | <para>
|
---|
[8770a48] | 131 | To test the results, issue this: <command>make tests</command>.
|
---|
[8f1699f2] | 132 | </para>
|
---|
[a1fd0f2] | 133 |
|
---|
[8f1699f2] | 134 | <para>
|
---|
[8770a48] | 135 | If you wish to generate the package documentation, you must have
|
---|
| 136 | <xref linkend="python2"/>, <xref linkend="texlive"/> (for HTML
|
---|
| 137 | documentation), and <xref linkend="gs"/> (for PDF docs) installed, then
|
---|
| 138 | issue the following commands:
|
---|
[8f1699f2] | 139 | </para>
|
---|
[d260aaf4] | 140 |
|
---|
[8770a48] | 141 | <screen><userinput>sed -i 's:man/man1:share/&:' ../doc/CMakeLists.txt &&
|
---|
| 142 |
|
---|
| 143 | cmake -DDOC_INSTALL_DIR=share/doc/doxygen-&doxygen-version; -Dbuild_doc=ON .. &&
|
---|
| 144 |
|
---|
| 145 | make docs</userinput></screen>
|
---|
[faa80ab] | 146 |
|
---|
[8f1699f2] | 147 | <para>
|
---|
[8770a48] | 148 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[8f1699f2] | 149 | </para>
|
---|
[a1fd0f2] | 150 |
|
---|
[8770a48] | 151 | <screen role="root"><userinput>make install &&
|
---|
| 152 | install -v -m644 ../doc/*.1 /usr/share/man/man1</userinput></screen>
|
---|
| 153 |
|
---|
| 154 | <para>
|
---|
| 155 |
|
---|
| 156 | If you generated the package documentation, install it by executing the
|
---|
| 157 | following command as the <systemitem class="username">root</systemitem> user:
|
---|
| 158 | </para>
|
---|
| 159 |
|
---|
| 160 | <screen role="root"><userinput>make docs install</userinput></screen>
|
---|
[a1fd0f2] | 161 |
|
---|
[1bbef1e] | 162 | </sect2>
|
---|
| 163 |
|
---|
| 164 | <sect2 role="commands">
|
---|
| 165 | <title>Command Explanations</title>
|
---|
| 166 |
|
---|
[8f1699f2] | 167 | <para>
|
---|
[8770a48] | 168 | <command>sed -i ... CMakeLists.txt</command>: Fixes the directory where
|
---|
| 169 | the man pages are installed.
|
---|
| 170 | </para>
|
---|
| 171 |
|
---|
| 172 | <para>
|
---|
| 173 | <option>-Dbuild_wizard=ON</option>: Use this switch if
|
---|
| 174 | <application>Qt4</application> is installed and you wish to build the GUI
|
---|
| 175 | frontend.
|
---|
[ac38e9dc] | 176 | </para>
|
---|
| 177 |
|
---|
| 178 | <para>
|
---|
[8770a48] | 179 | <option>-Dbuild_search=ON</option>: Use this switch if
|
---|
| 180 | you have installed <xref linkend="xapian"/> and you wish to build the
|
---|
| 181 | external search tools (<command>doxysearch.cgi</command> and
|
---|
[ac38e9dc] | 182 | <command>doxyindexer</command>).
|
---|
| 183 | </para>
|
---|
| 184 |
|
---|
| 185 | <para>
|
---|
[8770a48] | 186 | <option>-Duse_libclang=ON</option>: Use this switch if
|
---|
[ac38e9dc] | 187 | you have installed <application>Clang</application>
|
---|
| 188 | and you wish to to add support for libclang parsing.
|
---|
[8f1699f2] | 189 | </para>
|
---|
[1bbef1e] | 190 |
|
---|
[a1fd0f2] | 191 | </sect2>
|
---|
[1bbef1e] | 192 |
|
---|
[a1fd0f2] | 193 | <sect2 role="configuration">
|
---|
| 194 | <title>Configuring Doxygen</title>
|
---|
[1bbef1e] | 195 |
|
---|
[8f1699f2] | 196 | <para>
|
---|
| 197 | There is no real configuration necessary for the
|
---|
| 198 | <application>Doxygen</application> package although three additional
|
---|
| 199 | packages are required if you wish to use extended capabilities. If you
|
---|
| 200 | need to use the language translation features, you must have <xref
|
---|
| 201 | linkend="python2"/> installed. If you require formulas to create PDF
|
---|
| 202 | documentation, then you must have <xref linkend="texlive"/> installed.
|
---|
| 203 | If you require formulas to convert PostScript files to bitmaps, then
|
---|
| 204 | you must have <xref linkend="gs"/> installed.
|
---|
| 205 | </para>
|
---|
[1bbef1e] | 206 |
|
---|
| 207 | </sect2>
|
---|
| 208 |
|
---|
| 209 | <sect2 role="content">
|
---|
| 210 | <title>Contents</title>
|
---|
| 211 |
|
---|
| 212 | <segmentedlist>
|
---|
| 213 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 214 | <segtitle>Installed Libraries</segtitle>
|
---|
[1bbef1e] | 215 | <segtitle>Installed Directory</segtitle>
|
---|
| 216 |
|
---|
| 217 | <seglistitem>
|
---|
[8f1699f2] | 218 | <seg>
|
---|
[ac38e9dc] | 219 | doxygen and optionally,
|
---|
| 220 | doxywizard, doxyindexer and doxysearch.cgi
|
---|
[8f1699f2] | 221 | </seg>
|
---|
[c3c56b2] | 222 | <seg>
|
---|
| 223 | None
|
---|
| 224 | </seg>
|
---|
[8f1699f2] | 225 | <seg>
|
---|
| 226 | /usr/share/doc/doxygen-&doxygen-version;
|
---|
| 227 | </seg>
|
---|
[1bbef1e] | 228 | </seglistitem>
|
---|
| 229 | </segmentedlist>
|
---|
| 230 |
|
---|
| 231 | <variablelist>
|
---|
| 232 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 233 | <?dbfo list-presentation="list"?>
|
---|
| 234 | <?dbhtml list-presentation="table"?>
|
---|
| 235 |
|
---|
| 236 | <varlistentry id="doxygen-prog">
|
---|
| 237 | <term><command>doxygen</command></term>
|
---|
| 238 | <listitem>
|
---|
[8f1699f2] | 239 | <para>
|
---|
| 240 | is a command-line based utility used to generate template
|
---|
| 241 | configuration files and then generate documentation from these
|
---|
| 242 | templates. Use <command>doxygen --help</command> for an
|
---|
| 243 | explanation of the command-line parameters.
|
---|
| 244 | </para>
|
---|
[1bbef1e] | 245 | <indexterm zone="doxygen doxygen-prog">
|
---|
| 246 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
| 247 | </indexterm>
|
---|
| 248 | </listitem>
|
---|
| 249 | </varlistentry>
|
---|
| 250 |
|
---|
| 251 | <varlistentry id="doxywizard">
|
---|
| 252 | <term><command>doxywizard</command></term>
|
---|
| 253 | <listitem>
|
---|
[8f1699f2] | 254 | <para>
|
---|
| 255 | is a GUI front-end for configuring and
|
---|
| 256 | running <command>doxygen</command>.
|
---|
| 257 | </para>
|
---|
[1bbef1e] | 258 | <indexterm zone="doxygen doxywizard">
|
---|
| 259 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
| 260 | </indexterm>
|
---|
| 261 | </listitem>
|
---|
| 262 | </varlistentry>
|
---|
[8f1699f2] | 263 |
|
---|
[ac38e9dc] | 264 | <varlistentry id="doxyindexer">
|
---|
| 265 | <term><command>doxyindexer</command></term>
|
---|
| 266 | <listitem>
|
---|
| 267 | <para>
|
---|
| 268 | generates a search index called <filename>doxysearch.db</filename>
|
---|
| 269 | from one or more search data files produced by
|
---|
| 270 | <command>doxygen</command>.
|
---|
| 271 | </para>
|
---|
| 272 | <indexterm zone="doxygen doxyindexer">
|
---|
| 273 | <primary sortas="b-doxyindexer">doxyindexer</primary>
|
---|
| 274 | </indexterm>
|
---|
| 275 | </listitem>
|
---|
| 276 | </varlistentry>
|
---|
| 277 |
|
---|
| 278 | <varlistentry id="doxysearch.cgi">
|
---|
| 279 | <term><command>doxysearch.cgi</command></term>
|
---|
| 280 | <listitem>
|
---|
| 281 | <para>
|
---|
| 282 | is a CGI program to search the data indexed by
|
---|
| 283 | <command>doxyindexer</command>.
|
---|
| 284 | </para>
|
---|
| 285 | <indexterm zone="doxygen doxysearch.cgi">
|
---|
| 286 | <primary sortas="b-doxysearch.cgi">doxysearch.cgi</primary>
|
---|
| 287 | </indexterm>
|
---|
| 288 | </listitem>
|
---|
| 289 | </varlistentry>
|
---|
| 290 |
|
---|
[1bbef1e] | 291 | </variablelist>
|
---|
| 292 |
|
---|
| 293 | </sect2>
|
---|
[faa80ab] | 294 |
|
---|
| 295 | </sect1>
|
---|