[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 |
|
---|
[a1fd0f2] | 7 | <!ENTITY doxygen-download-http "http://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
|
---|
[faa80ab] | 8 | <!ENTITY doxygen-download-ftp "ftp://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
|
---|
[3ffdec68] | 9 | <!ENTITY doxygen-md5sum "d5f3e32474186abc64288db6b8ffd7f0">
|
---|
| 10 | <!ENTITY doxygen-size "4.1 MB">
|
---|
| 11 | <!ENTITY doxygen-buildsize "68 MB">
|
---|
| 12 | <!ENTITY doxygen-time "2.0 SBU (includes building the GUI frontend and all docs)">
|
---|
[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 |
|
---|
[a1fd0f2] | 32 | <para>The <application>Doxygen</application> package contains a
|
---|
| 33 | documentation system for C++, C, Java, Objective-C, Corba IDL and to some
|
---|
| 34 | extent PHP, C# and D. This is useful for generating HTML documentation
|
---|
| 35 | and/or an off-line reference manual from a set of documented source files.
|
---|
| 36 | There is also support for generating output in RTF, PostScript, hyperlinked
|
---|
| 37 | PDF, compressed HTML, and Unix man pages. The documentation is extracted
|
---|
| 38 | directly from the sources, which makes it much easier to keep the
|
---|
[1bbef1e] | 39 | documentation consistent with the source code.</para>
|
---|
| 40 |
|
---|
[a1fd0f2] | 41 | <para>You can also configure <application>Doxygen</application> to extract
|
---|
| 42 | the code structure from undocumented source files. This is very useful to
|
---|
| 43 | quickly find your way in large source distributions. Used along with
|
---|
[6722219] | 44 | <application>Graphviz</application>, you can also visualize the relations
|
---|
[7cd76d62] | 45 | between the various elements by means of include dependency graphs,
|
---|
| 46 | inheritance diagrams, and collaboration diagrams, which are all generated
|
---|
[1bbef1e] | 47 | automatically.</para>
|
---|
| 48 |
|
---|
| 49 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 50 | <itemizedlist spacing="compact">
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download (HTTP): <ulink url="&doxygen-download-http;"/></para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download (FTP): <ulink url="&doxygen-download-ftp;"/></para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Download MD5 sum: &doxygen-md5sum;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Download size: &doxygen-size;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>Estimated disk space required: &doxygen-buildsize;</para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>Estimated build time: &doxygen-time;</para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[56e902b] | 74 | <para role="optional"><xref linkend="qt4"/> (for doxywizard),
|
---|
[e41e360] | 75 | <xref linkend="graphviz"/>,
|
---|
[6e5f13bd] | 76 | <xref linkend="python"/>,
|
---|
[f1e103a] | 77 | <xref linkend="tetex"/> or <xref linkend="texlive"/>,
|
---|
[aa8ef3bc] | 78 | <!-- <xref linkend="espgs"/> or --><xref linkend="gs"/></para>
|
---|
[1bbef1e] | 79 |
|
---|
[1039de3] | 80 | <para condition="html" role="usernotes">User Notes:
|
---|
| 81 | <ulink url="&blfs-wiki;/doxygen"/></para>
|
---|
| 82 |
|
---|
[1bbef1e] | 83 | </sect2>
|
---|
| 84 |
|
---|
| 85 | <sect2 role="installation">
|
---|
| 86 | <title>Installation of Doxygen</title>
|
---|
| 87 |
|
---|
[56e902b] | 88 | <note><para>If you have both <xref linkend='qt'/> and <xref linkend='qt4'/>
|
---|
| 89 | installed, be sure to set the environment variable QTDIR to point to the
|
---|
| 90 | <application>Qt4</application> top level directory if you add the
|
---|
| 91 | <option>--with-doxywizard</option> option.</para></note>
|
---|
| 92 |
|
---|
[7cd76d62] | 93 | <para>Install <application>Doxygen</application> by running the following
|
---|
[1bbef1e] | 94 | commands:</para>
|
---|
| 95 |
|
---|
[e41e360] | 96 | <screen><userinput>./configure --prefix /usr \
|
---|
[199a5c9a] | 97 | --docdir /usr/share/doc/doxygen-&doxygen-version; &&
|
---|
[1bbef1e] | 98 | make</userinput></screen>
|
---|
[d260aaf4] | 99 |
|
---|
[a1fd0f2] | 100 | <para>This package does not come with a test suite.</para>
|
---|
| 101 |
|
---|
[1bbef1e] | 102 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[d260aaf4] | 103 |
|
---|
[1bbef1e] | 104 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[faa80ab] | 105 |
|
---|
[a1fd0f2] | 106 | <para>If you wish to generate and install the package documentation
|
---|
| 107 | (note that man pages have already been installed), you must have
|
---|
[f1e103a] | 108 | <application>Python</application>, <application>teTeX</application> or
|
---|
| 109 | <application>TeX Live</application> (for HTML docs) and
|
---|
| 110 | <application>Ghostscript</application> (for PDF docs)
|
---|
[6e5f13bd] | 111 | installed, then issue the following command as the
|
---|
[30d63593] | 112 | <systemitem class="username">root</systemitem> user:</para>
|
---|
[a1fd0f2] | 113 |
|
---|
| 114 | <screen role="root"><userinput>make install_docs</userinput></screen>
|
---|
| 115 |
|
---|
[1bbef1e] | 116 | </sect2>
|
---|
| 117 |
|
---|
| 118 | <sect2 role="commands">
|
---|
| 119 | <title>Command Explanations</title>
|
---|
| 120 |
|
---|
[7cd76d62] | 121 | <para><option>--with-doxywizard</option>: Use this parameter if
|
---|
[56e902b] | 122 | <application>Qt4</application> is installed and you wish to build the
|
---|
[1bbef1e] | 123 | GUI front-end.</para>
|
---|
| 124 |
|
---|
[a1fd0f2] | 125 | </sect2>
|
---|
[1bbef1e] | 126 |
|
---|
[a1fd0f2] | 127 | <sect2 role="configuration">
|
---|
| 128 | <title>Configuring Doxygen</title>
|
---|
[1bbef1e] | 129 |
|
---|
[a1fd0f2] | 130 | <para>There is no real configuration necessary for the
|
---|
| 131 | <application>Doxygen</application> package although three additional
|
---|
[919683dc] | 132 | packages are required if you wish to use extended capabilities. If you
|
---|
[a1fd0f2] | 133 | need to use the language translation features, you must have
|
---|
| 134 | <xref linkend="python"/> installed. If you require formulas to
|
---|
[f1e103a] | 135 | create PDF documentation, then you must have <xref linkend="tetex"/> or
|
---|
| 136 | <xref linkend="texlive"/> installed. If you require formulas to convert
|
---|
| 137 | PostScript files to bitmaps, then you must have <xref linkend="gs"/>
|
---|
| 138 | <!-- or <xref linkend="espgs"/> --> installed.</para>
|
---|
[1bbef1e] | 139 |
|
---|
| 140 | </sect2>
|
---|
| 141 |
|
---|
| 142 | <sect2 role="content">
|
---|
| 143 | <title>Contents</title>
|
---|
| 144 |
|
---|
| 145 | <segmentedlist>
|
---|
| 146 | <segtitle>Installed Programs</segtitle>
|
---|
| 147 | <segtitle>Installed Libraries</segtitle>
|
---|
| 148 | <segtitle>Installed Directory</segtitle>
|
---|
| 149 |
|
---|
| 150 | <seglistitem>
|
---|
[a1fd0f2] | 151 | <seg>doxygen, doxytag, and optionally, doxywizard</seg>
|
---|
[1bbef1e] | 152 | <seg>None</seg>
|
---|
| 153 | <seg>/usr/share/doc/doxygen</seg>
|
---|
| 154 | </seglistitem>
|
---|
| 155 | </segmentedlist>
|
---|
| 156 |
|
---|
| 157 | <variablelist>
|
---|
| 158 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 159 | <?dbfo list-presentation="list"?>
|
---|
| 160 | <?dbhtml list-presentation="table"?>
|
---|
| 161 |
|
---|
| 162 | <varlistentry id="doxygen-prog">
|
---|
| 163 | <term><command>doxygen</command></term>
|
---|
| 164 | <listitem>
|
---|
[7cd76d62] | 165 | <para>is a command-line based utility used to generate template
|
---|
| 166 | configuration files and then generate documentation from these templates. Use
|
---|
| 167 | <command>doxygen --help</command> for an explanation of the command-line
|
---|
[1bbef1e] | 168 | parameters.</para>
|
---|
| 169 | <indexterm zone="doxygen doxygen-prog">
|
---|
| 170 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
| 171 | </indexterm>
|
---|
| 172 | </listitem>
|
---|
| 173 | </varlistentry>
|
---|
| 174 |
|
---|
| 175 | <varlistentry id="doxytag">
|
---|
| 176 | <term><command>doxytag</command></term>
|
---|
| 177 | <listitem>
|
---|
[7cd76d62] | 178 | <para>is used to generate a tag file and/or a search index for a set
|
---|
[1bbef1e] | 179 | of HTML files.</para>
|
---|
| 180 | <indexterm zone="doxygen doxytag">
|
---|
| 181 | <primary sortas="b-doxytag">doxytag</primary>
|
---|
| 182 | </indexterm>
|
---|
| 183 | </listitem>
|
---|
| 184 | </varlistentry>
|
---|
| 185 |
|
---|
| 186 | <varlistentry id="doxywizard">
|
---|
| 187 | <term><command>doxywizard</command></term>
|
---|
| 188 | <listitem>
|
---|
[7cd76d62] | 189 | <para>is a GUI front-end for configuring and
|
---|
[1bbef1e] | 190 | running <command>doxygen</command>.</para>
|
---|
| 191 | <indexterm zone="doxygen doxywizard">
|
---|
| 192 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
| 193 | </indexterm>
|
---|
| 194 | </listitem>
|
---|
| 195 | </varlistentry>
|
---|
| 196 | </variablelist>
|
---|
| 197 |
|
---|
| 198 | </sect2>
|
---|
[faa80ab] | 199 |
|
---|
| 200 | </sect1>
|
---|