[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>
|
---|
[256ee72c] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">doxygen-&doxygen-version;.src.tar</keyword>
|
---|
| 23 | <keyword role="ftptdir">doxygen</keyword>
|
---|
| 24 | </keywordset>
|
---|
[1bbef1e] | 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>Doxygen-&doxygen-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="doxygen">
|
---|
| 30 | <primary sortas="a-Doxygen">Doxygen</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to Doxygen</title>
|
---|
| 35 |
|
---|
[a1fd0f2] | 36 | <para>The <application>Doxygen</application> package contains a
|
---|
| 37 | documentation system for C++, C, Java, Objective-C, Corba IDL and to some
|
---|
| 38 | extent PHP, C# and D. This is useful for generating HTML documentation
|
---|
| 39 | and/or an off-line reference manual from a set of documented source files.
|
---|
| 40 | There is also support for generating output in RTF, PostScript, hyperlinked
|
---|
| 41 | PDF, compressed HTML, and Unix man pages. The documentation is extracted
|
---|
| 42 | directly from the sources, which makes it much easier to keep the
|
---|
[1bbef1e] | 43 | documentation consistent with the source code.</para>
|
---|
| 44 |
|
---|
[a1fd0f2] | 45 | <para>You can also configure <application>Doxygen</application> to extract
|
---|
| 46 | the code structure from undocumented source files. This is very useful to
|
---|
| 47 | quickly find your way in large source distributions. Used along with
|
---|
[7cd76d62] | 48 | <application>GraphViz</application>, you can also visualize the relations
|
---|
| 49 | between the various elements by means of include dependency graphs,
|
---|
| 50 | inheritance diagrams, and collaboration diagrams, which are all generated
|
---|
[1bbef1e] | 51 | automatically.</para>
|
---|
| 52 |
|
---|
| 53 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 54 | <itemizedlist spacing="compact">
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Download (HTTP): <ulink url="&doxygen-download-http;"/></para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Download (FTP): <ulink url="&doxygen-download-ftp;"/></para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>Download MD5 sum: &doxygen-md5sum;</para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>Download size: &doxygen-size;</para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>Estimated disk space required: &doxygen-buildsize;</para>
|
---|
| 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
| 71 | <para>Estimated build time: &doxygen-time;</para>
|
---|
| 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[256ee72c] | 78 | <para role="optional"><xref linkend="qt"/>,
|
---|
[30d63593] | 79 | <xref linkend="tex"/>,
|
---|
| 80 | <xref linkend="espgs"/> or <xref linkend="gs"/>, and
|
---|
[1bbef1e] | 81 | <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
|
---|
| 82 |
|
---|
| 83 | </sect2>
|
---|
| 84 |
|
---|
| 85 | <sect2 role="installation">
|
---|
| 86 | <title>Installation of Doxygen</title>
|
---|
| 87 |
|
---|
[7cd76d62] | 88 | <para>Install <application>Doxygen</application> by running the following
|
---|
[1bbef1e] | 89 | commands:</para>
|
---|
| 90 |
|
---|
| 91 | <screen><userinput>rm src/unistd.h &&
|
---|
[faa80ab] | 92 | ./configure --prefix /usr --docdir /usr/share/doc &&
|
---|
[1bbef1e] | 93 | make</userinput></screen>
|
---|
[d260aaf4] | 94 |
|
---|
[a1fd0f2] | 95 | <para>This package does not come with a test suite.</para>
|
---|
| 96 |
|
---|
[1bbef1e] | 97 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[d260aaf4] | 98 |
|
---|
[1bbef1e] | 99 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[faa80ab] | 100 |
|
---|
[a1fd0f2] | 101 | <para>If you wish to generate and install the package documentation
|
---|
| 102 | (note that man pages have already been installed), you must have
|
---|
[30d63593] | 103 | <application>TeX</application> (for HTML docs) and
|
---|
| 104 | <application>Ghostscript</application> (for PDF docs) installed, then
|
---|
| 105 | issue the following command as the
|
---|
| 106 | <systemitem class="username">root</systemitem> user:</para>
|
---|
[a1fd0f2] | 107 |
|
---|
| 108 | <screen role="root"><userinput>make install_docs</userinput></screen>
|
---|
| 109 |
|
---|
[c5cd635c] | 110 | <!--
|
---|
[a1fd0f2] | 111 | <tip>
|
---|
| 112 | <para>If you don't have <application>TeX</application> installed but
|
---|
| 113 | wish to generate and install the HTML documentation (very good docs),
|
---|
| 114 | issue the following commands:</para>
|
---|
| 115 |
|
---|
| 116 | <screen><userinput>make docs</userinput></screen>
|
---|
| 117 |
|
---|
| 118 | <para>Now, as the <systemitem class="username">root</systemitem>
|
---|
| 119 | user:</para>
|
---|
| 120 |
|
---|
| 121 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/doxygen &&
|
---|
| 122 | cp -v -R examples html /usr/share/doc/doxygen</userinput></screen>
|
---|
[faa80ab] | 123 |
|
---|
[a1fd0f2] | 124 | </tip>
|
---|
[c5cd635c] | 125 | -->
|
---|
[1bbef1e] | 126 |
|
---|
| 127 | </sect2>
|
---|
| 128 |
|
---|
| 129 | <sect2 role="commands">
|
---|
| 130 | <title>Command Explanations</title>
|
---|
| 131 |
|
---|
[7cd76d62] | 132 | <para><command>rm src/unistd.h</command>: There is a bug in
|
---|
| 133 | <application>Flex</application>-2.5.31 which causes
|
---|
| 134 | <command>make</command> to use this file instead of the system
|
---|
| 135 | installed version. Removing this file allows the GUI front-end to build
|
---|
[a1fd0f2] | 136 | successfully. This command is not required if you don't pass the
|
---|
| 137 | <option>--with-doxywizard</option> parameter (but won't affect the build
|
---|
| 138 | otherwise).</para>
|
---|
[1bbef1e] | 139 |
|
---|
[7cd76d62] | 140 | <para><option>--with-doxywizard</option>: Use this parameter if
|
---|
| 141 | <application>Qt</application> is installed and you wish to build the
|
---|
[1bbef1e] | 142 | GUI front-end.</para>
|
---|
| 143 |
|
---|
[a1fd0f2] | 144 | </sect2>
|
---|
[1bbef1e] | 145 |
|
---|
[a1fd0f2] | 146 | <sect2 role="configuration">
|
---|
| 147 | <title>Configuring Doxygen</title>
|
---|
[1bbef1e] | 148 |
|
---|
[a1fd0f2] | 149 | <para>There is no real configuration necessary for the
|
---|
| 150 | <application>Doxygen</application> package although three additional
|
---|
[919683dc] | 151 | packages are required if you wish to use extended capabilities. If you
|
---|
[a1fd0f2] | 152 | need to use the language translation features, you must have
|
---|
| 153 | <xref linkend="python"/> installed. If you require formulas to
|
---|
| 154 | create PDF documentation, then you must have <xref linkend="tex"/>
|
---|
| 155 | installed. If you require formulas to convert PostScript files to bitmaps,
|
---|
| 156 | then you must have <xref linkend="gs"/> or <xref linkend="espgs"/>
|
---|
| 157 | installed.</para>
|
---|
[1bbef1e] | 158 |
|
---|
| 159 | </sect2>
|
---|
| 160 |
|
---|
| 161 | <sect2 role="content">
|
---|
| 162 | <title>Contents</title>
|
---|
| 163 |
|
---|
| 164 | <segmentedlist>
|
---|
| 165 | <segtitle>Installed Programs</segtitle>
|
---|
| 166 | <segtitle>Installed Libraries</segtitle>
|
---|
| 167 | <segtitle>Installed Directory</segtitle>
|
---|
| 168 |
|
---|
| 169 | <seglistitem>
|
---|
[a1fd0f2] | 170 | <seg>doxygen, doxytag, and optionally, doxywizard</seg>
|
---|
[1bbef1e] | 171 | <seg>None</seg>
|
---|
| 172 | <seg>/usr/share/doc/doxygen</seg>
|
---|
| 173 | </seglistitem>
|
---|
| 174 | </segmentedlist>
|
---|
| 175 |
|
---|
| 176 | <variablelist>
|
---|
| 177 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 178 | <?dbfo list-presentation="list"?>
|
---|
| 179 | <?dbhtml list-presentation="table"?>
|
---|
| 180 |
|
---|
| 181 | <varlistentry id="doxygen-prog">
|
---|
| 182 | <term><command>doxygen</command></term>
|
---|
| 183 | <listitem>
|
---|
[7cd76d62] | 184 | <para>is a command-line based utility used to generate template
|
---|
| 185 | configuration files and then generate documentation from these templates. Use
|
---|
| 186 | <command>doxygen --help</command> for an explanation of the command-line
|
---|
[1bbef1e] | 187 | parameters.</para>
|
---|
| 188 | <indexterm zone="doxygen doxygen-prog">
|
---|
| 189 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
| 190 | </indexterm>
|
---|
| 191 | </listitem>
|
---|
| 192 | </varlistentry>
|
---|
| 193 |
|
---|
| 194 | <varlistentry id="doxytag">
|
---|
| 195 | <term><command>doxytag</command></term>
|
---|
| 196 | <listitem>
|
---|
[7cd76d62] | 197 | <para>is used to generate a tag file and/or a search index for a set
|
---|
[1bbef1e] | 198 | of HTML files.</para>
|
---|
| 199 | <indexterm zone="doxygen doxytag">
|
---|
| 200 | <primary sortas="b-doxytag">doxytag</primary>
|
---|
| 201 | </indexterm>
|
---|
| 202 | </listitem>
|
---|
| 203 | </varlistentry>
|
---|
| 204 |
|
---|
| 205 | <varlistentry id="doxywizard">
|
---|
| 206 | <term><command>doxywizard</command></term>
|
---|
| 207 | <listitem>
|
---|
[7cd76d62] | 208 | <para>is a GUI front-end for configuring and
|
---|
[1bbef1e] | 209 | running <command>doxygen</command>.</para>
|
---|
| 210 | <indexterm zone="doxygen doxywizard">
|
---|
| 211 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
| 212 | </indexterm>
|
---|
| 213 | </listitem>
|
---|
| 214 | </varlistentry>
|
---|
| 215 | </variablelist>
|
---|
| 216 |
|
---|
| 217 | </sect2>
|
---|
[faa80ab] | 218 |
|
---|
| 219 | </sect1>
|
---|