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