[faa80ab] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/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">
|
---|
[c5cd635c] | 9 | <!ENTITY doxygen-md5sum "0e7fdbeafc6264cbde590c363a4debcd">
|
---|
| 10 | <!ENTITY doxygen-size "2.8 MB">
|
---|
| 11 | <!ENTITY doxygen-buildsize "43.4 MB (additional 3.8 MB to install docs)">
|
---|
[a1fd0f2] | 12 | <!ENTITY doxygen-time "1.4 SBU">
|
---|
[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
|
---|
[7cd76d62] | 44 | <application>GraphViz</application>, you can also visualize the relations
|
---|
| 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>
|
---|
[7cd76d62] | 74 | <para><xref linkend="qt"/>,
|
---|
[a1fd0f2] | 75 | <xref linkend="tex"/> and
|
---|
[1bbef1e] | 76 | <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
|
---|
| 77 |
|
---|
| 78 | </sect2>
|
---|
| 79 |
|
---|
| 80 | <sect2 role="installation">
|
---|
| 81 | <title>Installation of Doxygen</title>
|
---|
| 82 |
|
---|
[7cd76d62] | 83 | <para>Install <application>Doxygen</application> by running the following
|
---|
[1bbef1e] | 84 | commands:</para>
|
---|
| 85 |
|
---|
| 86 | <screen><userinput>rm src/unistd.h &&
|
---|
[faa80ab] | 87 | ./configure --prefix /usr --docdir /usr/share/doc &&
|
---|
[1bbef1e] | 88 | make</userinput></screen>
|
---|
[d260aaf4] | 89 |
|
---|
[a1fd0f2] | 90 | <para>This package does not come with a test suite.</para>
|
---|
| 91 |
|
---|
[1bbef1e] | 92 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[d260aaf4] | 93 |
|
---|
[1bbef1e] | 94 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[faa80ab] | 95 |
|
---|
[a1fd0f2] | 96 | <para>If you wish to generate and install the package documentation
|
---|
| 97 | (note that man pages have already been installed), you must have
|
---|
| 98 | <application>TeX</application> installed, then issue the following
|
---|
| 99 | command as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 100 |
|
---|
| 101 | <screen role="root"><userinput>make install_docs</userinput></screen>
|
---|
| 102 |
|
---|
[c5cd635c] | 103 | <!--
|
---|
[a1fd0f2] | 104 | <tip>
|
---|
| 105 | <para>If you don't have <application>TeX</application> installed but
|
---|
| 106 | wish to generate and install the HTML documentation (very good docs),
|
---|
| 107 | issue the following commands:</para>
|
---|
| 108 |
|
---|
| 109 | <screen><userinput>make docs</userinput></screen>
|
---|
| 110 |
|
---|
| 111 | <para>Now, as the <systemitem class="username">root</systemitem>
|
---|
| 112 | user:</para>
|
---|
| 113 |
|
---|
| 114 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/doxygen &&
|
---|
| 115 | cp -v -R examples html /usr/share/doc/doxygen</userinput></screen>
|
---|
[faa80ab] | 116 |
|
---|
[a1fd0f2] | 117 | </tip>
|
---|
[c5cd635c] | 118 | -->
|
---|
[1bbef1e] | 119 |
|
---|
| 120 | </sect2>
|
---|
| 121 |
|
---|
| 122 | <sect2 role="commands">
|
---|
| 123 | <title>Command Explanations</title>
|
---|
| 124 |
|
---|
[7cd76d62] | 125 | <para><command>rm src/unistd.h</command>: There is a bug in
|
---|
| 126 | <application>Flex</application>-2.5.31 which causes
|
---|
| 127 | <command>make</command> to use this file instead of the system
|
---|
| 128 | installed version. Removing this file allows the GUI front-end to build
|
---|
[a1fd0f2] | 129 | successfully. This command is not required if you don't pass the
|
---|
| 130 | <option>--with-doxywizard</option> parameter (but won't affect the build
|
---|
| 131 | otherwise).</para>
|
---|
[1bbef1e] | 132 |
|
---|
[7cd76d62] | 133 | <para><option>--with-doxywizard</option>: Use this parameter if
|
---|
| 134 | <application>Qt</application> is installed and you wish to build the
|
---|
[1bbef1e] | 135 | GUI front-end.</para>
|
---|
| 136 |
|
---|
[a1fd0f2] | 137 | </sect2>
|
---|
[1bbef1e] | 138 |
|
---|
[a1fd0f2] | 139 | <sect2 role="configuration">
|
---|
| 140 | <title>Configuring Doxygen</title>
|
---|
[1bbef1e] | 141 |
|
---|
[a1fd0f2] | 142 | <para>There is no real configuration necessary for the
|
---|
| 143 | <application>Doxygen</application> package although three additional
|
---|
[919683dc] | 144 | packages are required if you wish to use extended capabilities. If you
|
---|
[a1fd0f2] | 145 | need to use the language translation features, you must have
|
---|
| 146 | <xref linkend="python"/> installed. If you require formulas to
|
---|
| 147 | create PDF documentation, then you must have <xref linkend="tex"/>
|
---|
| 148 | installed. If you require formulas to convert PostScript files to bitmaps,
|
---|
| 149 | then you must have <xref linkend="gs"/> or <xref linkend="espgs"/>
|
---|
| 150 | installed.</para>
|
---|
[1bbef1e] | 151 |
|
---|
| 152 | </sect2>
|
---|
| 153 |
|
---|
| 154 | <sect2 role="content">
|
---|
| 155 | <title>Contents</title>
|
---|
| 156 |
|
---|
| 157 | <segmentedlist>
|
---|
| 158 | <segtitle>Installed Programs</segtitle>
|
---|
| 159 | <segtitle>Installed Libraries</segtitle>
|
---|
| 160 | <segtitle>Installed Directory</segtitle>
|
---|
| 161 |
|
---|
| 162 | <seglistitem>
|
---|
[a1fd0f2] | 163 | <seg>doxygen, doxytag, and optionally, doxywizard</seg>
|
---|
[1bbef1e] | 164 | <seg>None</seg>
|
---|
| 165 | <seg>/usr/share/doc/doxygen</seg>
|
---|
| 166 | </seglistitem>
|
---|
| 167 | </segmentedlist>
|
---|
| 168 |
|
---|
| 169 | <variablelist>
|
---|
| 170 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 171 | <?dbfo list-presentation="list"?>
|
---|
| 172 | <?dbhtml list-presentation="table"?>
|
---|
| 173 |
|
---|
| 174 | <varlistentry id="doxygen-prog">
|
---|
| 175 | <term><command>doxygen</command></term>
|
---|
| 176 | <listitem>
|
---|
[7cd76d62] | 177 | <para>is a command-line based utility used to generate template
|
---|
| 178 | configuration files and then generate documentation from these templates. Use
|
---|
| 179 | <command>doxygen --help</command> for an explanation of the command-line
|
---|
[1bbef1e] | 180 | parameters.</para>
|
---|
| 181 | <indexterm zone="doxygen doxygen-prog">
|
---|
| 182 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
| 183 | </indexterm>
|
---|
| 184 | </listitem>
|
---|
| 185 | </varlistentry>
|
---|
| 186 |
|
---|
| 187 | <varlistentry id="doxytag">
|
---|
| 188 | <term><command>doxytag</command></term>
|
---|
| 189 | <listitem>
|
---|
[7cd76d62] | 190 | <para>is used to generate a tag file and/or a search index for a set
|
---|
[1bbef1e] | 191 | of HTML files.</para>
|
---|
| 192 | <indexterm zone="doxygen doxytag">
|
---|
| 193 | <primary sortas="b-doxytag">doxytag</primary>
|
---|
| 194 | </indexterm>
|
---|
| 195 | </listitem>
|
---|
| 196 | </varlistentry>
|
---|
| 197 |
|
---|
| 198 | <varlistentry id="doxywizard">
|
---|
| 199 | <term><command>doxywizard</command></term>
|
---|
| 200 | <listitem>
|
---|
[7cd76d62] | 201 | <para>is a GUI front-end for configuring and
|
---|
[1bbef1e] | 202 | running <command>doxygen</command>.</para>
|
---|
| 203 | <indexterm zone="doxygen doxywizard">
|
---|
| 204 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
| 205 | </indexterm>
|
---|
| 206 | </listitem>
|
---|
| 207 | </varlistentry>
|
---|
| 208 | </variablelist>
|
---|
| 209 |
|
---|
| 210 | </sect2>
|
---|
[faa80ab] | 211 |
|
---|
| 212 | </sect1>
|
---|