[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 |
|
---|
| 7 | <!ENTITY doxygen-download-http " ">
|
---|
| 8 | <!ENTITY doxygen-download-ftp "ftp://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
|
---|
[44edf870] | 9 | <!ENTITY doxygen-md5sum "5e0b6c8854c87e06aaca78c81c5236ec">
|
---|
| 10 | <!ENTITY doxygen-size "2.8 MB">
|
---|
| 11 | <!ENTITY doxygen-buildsize "39.7 MB (additional 10.5 MB to build and install docs and <command>doxywizard</command>)">
|
---|
[6549833] | 12 | <!ENTITY doxygen-time "1.26 SBU (additional 0.50 SBU to build docs and <command>doxywizard</command>)">
|
---|
[faa80ab] | 13 | ]>
|
---|
| 14 |
|
---|
[cef3a2f] | 15 | <sect1 id="doxygen" xreflabel="Doxygen-&doxygen-version;">
|
---|
[faa80ab] | 16 | <sect1info>
|
---|
| 17 | <othername>$LastChangedBy$</othername>
|
---|
| 18 | <date>$Date$</date>
|
---|
| 19 | </sect1info>
|
---|
| 20 | <?dbhtml filename="doxygen.html"?>
|
---|
| 21 | <title>Doxygen-&doxygen-version;</title>
|
---|
[cef3a2f] | 22 | <indexterm zone="doxygen">
|
---|
[2ce558b1] | 23 | <primary sortas="a-Doxygen">Doxygen</primary></indexterm>
|
---|
[faa80ab] | 24 |
|
---|
| 25 | <sect2>
|
---|
| 26 | <title>Introduction to <application>Doxygen</application></title>
|
---|
| 27 |
|
---|
| 28 | <para>The <application>Doxygen</application> package contains a documentation
|
---|
| 29 | system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C#
|
---|
| 30 | and D. This is useful for generating <acronym>HTML</acronym> documentation
|
---|
| 31 | and/or an off-line reference manual from a set of documented source files.
|
---|
| 32 | There is also support for generating output in <acronym>RTF</acronym>,
|
---|
| 33 | PostScript, hyperlinked <acronym>PDF</acronym>, compressed
|
---|
| 34 | <acronym>HTML</acronym>, and Unix man pages. The documentation is extracted
|
---|
| 35 | directly from the sources, which makes it much easier to keep the
|
---|
| 36 | documentation consistent with the source code.</para>
|
---|
| 37 |
|
---|
| 38 | <para>You can also configure <application>Doxygen</application> to extract the
|
---|
| 39 | code structure from undocumented source files. This is very useful to quickly
|
---|
| 40 | find your way in large source distributions. Used along with
|
---|
| 41 | <application>GraphViz</application>, you can also visualize the relations
|
---|
| 42 | between the various elements by means of include dependency graphs,
|
---|
| 43 | inheritance diagrams, and collaboration diagrams, which are all generated
|
---|
| 44 | automatically.</para>
|
---|
| 45 |
|
---|
| 46 | <sect3><title>Package information</title>
|
---|
| 47 | <itemizedlist spacing="compact">
|
---|
[2ce558b1] | 48 | <listitem><para>Download (HTTP):
|
---|
| 49 | <ulink url="&doxygen-download-http;"/></para></listitem>
|
---|
| 50 | <listitem><para>Download (FTP):
|
---|
| 51 | <ulink url="&doxygen-download-ftp;"/></para></listitem>
|
---|
[23460a6] | 52 | <listitem><para>Download MD5 sum: &doxygen-md5sum;</para></listitem>
|
---|
[faa80ab] | 53 | <listitem><para>Download size: &doxygen-size;</para></listitem>
|
---|
[2ce558b1] | 54 | <listitem><para>Estimated disk space required:
|
---|
| 55 | &doxygen-buildsize;</para></listitem>
|
---|
| 56 | <listitem><para>Estimated build time:
|
---|
| 57 | &doxygen-time;</para></listitem></itemizedlist>
|
---|
[faa80ab] | 58 | </sect3>
|
---|
| 59 |
|
---|
| 60 | <sect3><title><application>Doxygen</application> dependencies</title>
|
---|
| 61 | <sect4><title>Optional</title>
|
---|
| 62 | <para><xref linkend="qt"/>,
|
---|
[775c349a] | 63 | <xref linkend="python"/>,
|
---|
[03d51788] | 64 | <xref linkend="tex"/>,
|
---|
[faa80ab] | 65 | <xref linkend="gs"/> or <xref linkend="espgs"/>, and
|
---|
| 66 | <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
|
---|
| 67 | </sect4>
|
---|
| 68 | </sect3>
|
---|
| 69 |
|
---|
| 70 | </sect2>
|
---|
| 71 |
|
---|
| 72 | <sect2>
|
---|
| 73 | <title>Installation of <application>Doxygen</application></title>
|
---|
| 74 |
|
---|
| 75 | <para>Install <application>Doxygen</application> by running the following
|
---|
| 76 | commands:</para>
|
---|
| 77 |
|
---|
| 78 | <screen><userinput><command>rm src/unistd.h &&
|
---|
| 79 | ./configure --prefix /usr --docdir /usr/share/doc &&
|
---|
[d260aaf4] | 80 | make</command></userinput></screen>
|
---|
| 81 |
|
---|
| 82 | <para>Now, as the root user:</para>
|
---|
| 83 |
|
---|
| 84 | <screen><userinput role='root'><command>make install</command></userinput></screen>
|
---|
[faa80ab] | 85 |
|
---|
[44edf870] | 86 | <para>If you wish to generate and install the package documentation (which
|
---|
| 87 | includes the man pages), ensure the <application>Python</application>,
|
---|
| 88 | <application>TeX</application> and <application>GraphViz</application>
|
---|
| 89 | packages are installed, then substitute the following commands for the
|
---|
| 90 | <command>make install</command> command above:</para>
|
---|
[faa80ab] | 91 |
|
---|
[d260aaf4] | 92 | <screen><userinput role='root'><command>make docs &&
|
---|
[faa80ab] | 93 | make pdf &&
|
---|
[6549833] | 94 | install -v -d -m755 /usr/share/doc/doxygen/src &&
|
---|
| 95 | install -v -m644 src/translator{,_adapter,_en}.h \
|
---|
[faa80ab] | 96 | /usr/share/doc/doxygen/src &&
|
---|
[6549833] | 97 | install -v -m644 VERSION /usr/share/doc/doxygen &&
|
---|
[faa80ab] | 98 | make install_docs</command></userinput></screen>
|
---|
| 99 |
|
---|
| 100 | </sect2>
|
---|
| 101 |
|
---|
| 102 | <sect2>
|
---|
| 103 | <title>Command explanations</title>
|
---|
| 104 |
|
---|
| 105 | <para><command>rm src/unistd.h</command>: There is a bug in
|
---|
| 106 | <application>Flex</application>-2.5.31 which causes <command>make</command> to
|
---|
| 107 | use this file instead of the system installed version. Removing this file
|
---|
| 108 | allows the <acronym>GUI</acronym> front-end to build successfully.</para>
|
---|
| 109 |
|
---|
| 110 | <para><option>--with-doxywizard</option>: Use this parameter if
|
---|
| 111 | <application>Qt</application> is installed and you wish to build the
|
---|
| 112 | <acronym>GUI</acronym> front-end.</para>
|
---|
| 113 |
|
---|
[44edf870] | 114 | <para><command>make docs</command>: This command builds the man pages and
|
---|
[faa80ab] | 115 | <acronym>HTML</acronym> documentation.</para>
|
---|
| 116 |
|
---|
| 117 | <para><command>make pdf</command>: This command builds a
|
---|
| 118 | <acronym>PDF</acronym> version of the <application>Doxygen</application>
|
---|
| 119 | Manual.</para>
|
---|
| 120 |
|
---|
| 121 | <para><command>install ...</command>: These commands install some files
|
---|
| 122 | required by the documentation installation.</para>
|
---|
| 123 |
|
---|
| 124 | <para><emphasis>Note: For documentation in a language other than English,
|
---|
| 125 | replace the <quote>_en</quote> with the country code of your
|
---|
| 126 | locale.</emphasis></para>
|
---|
| 127 |
|
---|
| 128 | <para><command>make install_docs</command>: This command installs the binaries
|
---|
| 129 | and documentation.</para>
|
---|
| 130 |
|
---|
| 131 | </sect2>
|
---|
| 132 |
|
---|
| 133 | <sect2>
|
---|
| 134 | <title>Contents</title>
|
---|
| 135 |
|
---|
[2ce558b1] | 136 | <segmentedlist>
|
---|
| 137 | <segtitle>Installed Programs</segtitle>
|
---|
[6549833] | 138 | <segtitle>Installed Libraries</segtitle>
|
---|
[2ce558b1] | 139 | <segtitle>Installed Directory</segtitle>
|
---|
[6549833] | 140 |
|
---|
[2ce558b1] | 141 | <seglistitem>
|
---|
| 142 | <seg>doxygen, doxytag and doxywizard</seg>
|
---|
[6549833] | 143 | <seg>None</seg>
|
---|
[2ce558b1] | 144 | <seg>/usr/share/doc/doxygen</seg>
|
---|
| 145 | </seglistitem>
|
---|
| 146 | </segmentedlist>
|
---|
| 147 |
|
---|
| 148 | <variablelist>
|
---|
| 149 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 150 | <?dbfo list-presentation="list"?>
|
---|
| 151 |
|
---|
[cef3a2f] | 152 | <varlistentry id="doxygen-prog">
|
---|
[2ce558b1] | 153 | <term><command>doxygen</command></term>
|
---|
| 154 | <listitem><para>is a command-line based utility used to generate template
|
---|
| 155 | configuration files and then generate documentation from these templates. Use
|
---|
| 156 | <command>doxygen --help</command> for an explanation of the command-line
|
---|
| 157 | parameters.</para>
|
---|
[cef3a2f] | 158 | <indexterm zone="doxygen doxygen-prog">
|
---|
[2ce558b1] | 159 | <primary sortas="b-doxygen">doxygen</primary></indexterm>
|
---|
| 160 | </listitem>
|
---|
| 161 | </varlistentry>
|
---|
| 162 |
|
---|
| 163 | <varlistentry id="doxytag">
|
---|
| 164 | <term><command>doxytag</command></term>
|
---|
| 165 | <listitem><para>is used to generate a tag file and/or a search index for a set
|
---|
| 166 | of <acronym>HTML</acronym> files.</para>
|
---|
[cef3a2f] | 167 | <indexterm zone="doxygen doxytag">
|
---|
[2ce558b1] | 168 | <primary sortas="b-doxytag">doxytag</primary></indexterm>
|
---|
| 169 | </listitem>
|
---|
| 170 | </varlistentry>
|
---|
| 171 |
|
---|
| 172 | <varlistentry id="doxywizard">
|
---|
| 173 | <term><command>doxywizard</command></term>
|
---|
| 174 | <listitem><para>is a <acronym>GUI</acronym> front-end for configuring and
|
---|
| 175 | running <command>doxygen</command>.</para>
|
---|
[cef3a2f] | 176 | <indexterm zone="doxygen doxywizard">
|
---|
[2ce558b1] | 177 | <primary sortas="b-doxywizard">doxywizard</primary></indexterm>
|
---|
| 178 | </listitem>
|
---|
| 179 | </varlistentry>
|
---|
| 180 | </variablelist>
|
---|
[faa80ab] | 181 |
|
---|
| 182 | </sect2>
|
---|
| 183 |
|
---|
| 184 | </sect1>
|
---|
| 185 |
|
---|