[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">
|
---|
[73e20ce] | 9 | <!ENTITY doxygen-md5sum "db51274568755e2c75c2657e30a78a55">
|
---|
[a45ecf51] | 10 | <!ENTITY doxygen-size "6.2 MB">
|
---|
[73e20ce] | 11 | <!ENTITY doxygen-buildsize "81 MB">
|
---|
| 12 | <!ENTITY doxygen-time "1.2 SBU (includes building the GUI frontend)">
|
---|
[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 |
|
---|
[73e20ce] | 53 | &lfs74_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 |
|
---|
| 91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[8f1699f2] | 92 | <para role="optional">
|
---|
| 93 | <xref linkend="graphviz"/>,
|
---|
| 94 | <xref linkend="gs"/>,
|
---|
| 95 | <xref linkend="python2"/>,
|
---|
[7af92fe5] | 96 | <xref linkend="qt4"/> (for doxywizard) and
|
---|
[8f1699f2] | 97 | <xref linkend="texlive"/>
|
---|
| 98 | </para>
|
---|
[1bbef1e] | 99 |
|
---|
[1039de3] | 100 | <para condition="html" role="usernotes">User Notes:
|
---|
[8f1699f2] | 101 | <ulink url="&blfs-wiki;/doxygen"/>
|
---|
| 102 | </para>
|
---|
[1bbef1e] | 103 | </sect2>
|
---|
| 104 |
|
---|
| 105 | <sect2 role="installation">
|
---|
| 106 | <title>Installation of Doxygen</title>
|
---|
| 107 |
|
---|
[8f1699f2] | 108 | <para>
|
---|
| 109 | Install <application>Doxygen</application> by running the following
|
---|
| 110 | commands:
|
---|
| 111 | </para>
|
---|
[1bbef1e] | 112 |
|
---|
[e41e360] | 113 | <screen><userinput>./configure --prefix /usr \
|
---|
[199a5c9a] | 114 | --docdir /usr/share/doc/doxygen-&doxygen-version; &&
|
---|
[1bbef1e] | 115 | make</userinput></screen>
|
---|
[d260aaf4] | 116 |
|
---|
[8f1699f2] | 117 | <para>
|
---|
| 118 | This package does not come with a test suite.
|
---|
| 119 | </para>
|
---|
[a1fd0f2] | 120 |
|
---|
[8f1699f2] | 121 | <para>
|
---|
| 122 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 123 | </para>
|
---|
[d260aaf4] | 124 |
|
---|
[1bbef1e] | 125 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[faa80ab] | 126 |
|
---|
[8f1699f2] | 127 | <para>
|
---|
| 128 | If you wish to generate and install the package documentation
|
---|
| 129 | (note that man pages have already been installed), you must have
|
---|
[0d7900a] | 130 | <application>Python</application>,
|
---|
[8f1699f2] | 131 | <application>TeX Live</application> (for HTML docs) and
|
---|
| 132 | <application>Ghostscript</application> (for PDF docs)
|
---|
| 133 | installed, then issue the following command as the
|
---|
| 134 | <systemitem class="username">root</systemitem> user:
|
---|
| 135 | </para>
|
---|
[a1fd0f2] | 136 |
|
---|
| 137 | <screen role="root"><userinput>make install_docs</userinput></screen>
|
---|
| 138 |
|
---|
[1bbef1e] | 139 | </sect2>
|
---|
| 140 |
|
---|
| 141 | <sect2 role="commands">
|
---|
| 142 | <title>Command Explanations</title>
|
---|
| 143 |
|
---|
[8f1699f2] | 144 | <para>
|
---|
| 145 | <option>--with-doxywizard</option>: Use this parameter if
|
---|
| 146 | <application>Qt</application> is installed and you wish to
|
---|
| 147 | build the GUI front-end.
|
---|
| 148 | </para>
|
---|
[1bbef1e] | 149 |
|
---|
[a1fd0f2] | 150 | </sect2>
|
---|
[1bbef1e] | 151 |
|
---|
[a1fd0f2] | 152 | <sect2 role="configuration">
|
---|
| 153 | <title>Configuring Doxygen</title>
|
---|
[1bbef1e] | 154 |
|
---|
[8f1699f2] | 155 | <para>
|
---|
| 156 | There is no real configuration necessary for the
|
---|
| 157 | <application>Doxygen</application> package although three additional
|
---|
| 158 | packages are required if you wish to use extended capabilities. If you
|
---|
| 159 | need to use the language translation features, you must have <xref
|
---|
| 160 | linkend="python2"/> installed. If you require formulas to create PDF
|
---|
| 161 | documentation, then you must have <xref linkend="texlive"/> installed.
|
---|
| 162 | If you require formulas to convert PostScript files to bitmaps, then
|
---|
| 163 | you must have <xref linkend="gs"/> installed.
|
---|
| 164 | </para>
|
---|
[1bbef1e] | 165 |
|
---|
| 166 | </sect2>
|
---|
| 167 |
|
---|
| 168 | <sect2 role="content">
|
---|
| 169 | <title>Contents</title>
|
---|
| 170 |
|
---|
| 171 | <segmentedlist>
|
---|
| 172 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 173 | <segtitle>Installed Libraries</segtitle>
|
---|
[1bbef1e] | 174 | <segtitle>Installed Directory</segtitle>
|
---|
| 175 |
|
---|
| 176 | <seglistitem>
|
---|
[8f1699f2] | 177 | <seg>
|
---|
| 178 | doxygen and optionally, doxywizard
|
---|
| 179 | </seg>
|
---|
[c3c56b2] | 180 | <seg>
|
---|
| 181 | None
|
---|
| 182 | </seg>
|
---|
[8f1699f2] | 183 | <seg>
|
---|
| 184 | /usr/share/doc/doxygen-&doxygen-version;
|
---|
| 185 | </seg>
|
---|
[1bbef1e] | 186 | </seglistitem>
|
---|
| 187 | </segmentedlist>
|
---|
| 188 |
|
---|
| 189 | <variablelist>
|
---|
| 190 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 191 | <?dbfo list-presentation="list"?>
|
---|
| 192 | <?dbhtml list-presentation="table"?>
|
---|
| 193 |
|
---|
| 194 | <varlistentry id="doxygen-prog">
|
---|
| 195 | <term><command>doxygen</command></term>
|
---|
| 196 | <listitem>
|
---|
[8f1699f2] | 197 | <para>
|
---|
| 198 | is a command-line based utility used to generate template
|
---|
| 199 | configuration files and then generate documentation from these
|
---|
| 200 | templates. Use <command>doxygen --help</command> for an
|
---|
| 201 | explanation of the command-line parameters.
|
---|
| 202 | </para>
|
---|
[1bbef1e] | 203 | <indexterm zone="doxygen doxygen-prog">
|
---|
| 204 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
| 205 | </indexterm>
|
---|
| 206 | </listitem>
|
---|
| 207 | </varlistentry>
|
---|
| 208 |
|
---|
| 209 | <varlistentry id="doxywizard">
|
---|
| 210 | <term><command>doxywizard</command></term>
|
---|
| 211 | <listitem>
|
---|
[8f1699f2] | 212 | <para>
|
---|
| 213 | is a GUI front-end for configuring and
|
---|
| 214 | running <command>doxygen</command>.
|
---|
| 215 | </para>
|
---|
[1bbef1e] | 216 | <indexterm zone="doxygen doxywizard">
|
---|
| 217 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
| 218 | </indexterm>
|
---|
| 219 | </listitem>
|
---|
| 220 | </varlistentry>
|
---|
[8f1699f2] | 221 |
|
---|
[1bbef1e] | 222 | </variablelist>
|
---|
| 223 |
|
---|
| 224 | </sect2>
|
---|
[faa80ab] | 225 |
|
---|
| 226 | </sect1>
|
---|