source: general/prog/doxygen.xml@ 7da83f1

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY doxygen-download-http " ">
  <!ENTITY doxygen-download-ftp  "ftp://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
  <!ENTITY doxygen-size          "2.7 MB">
  <!ENTITY doxygen-buildsize     "48 MB">
  <!ENTITY doxygen-time          "1.60 SBU">
]>

<sect1 id="doxygen" xreflabel="Doxygen-&doxygen-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="doxygen.html"?>
<title>Doxygen-&doxygen-version;</title>

<sect2>
<title>Introduction to <application>Doxygen</application></title>

<para>The <application>Doxygen</application> package contains a documentation 
system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C# 
and D. This is useful for generating <acronym>HTML</acronym> documentation 
and/or an off-line reference manual from a set of documented source files. 
There is also support for generating output in <acronym>RTF</acronym>, 
PostScript, hyperlinked <acronym>PDF</acronym>, compressed 
<acronym>HTML</acronym>, and Unix man pages. The documentation is extracted 
directly from the sources, which makes it much easier to keep the 
documentation consistent with the source code.</para>

<para>You can also configure <application>Doxygen</application> to extract the 
code structure from undocumented source files. This is very useful to quickly 
find your way in large source distributions. Used along with 
<application>GraphViz</application>, you can also visualize the relations 
between the various elements by means of include dependency graphs, 
inheritance diagrams, and collaboration diagrams, which are all generated 
automatically.</para>

<sect3><title>Package information</title>
<itemizedlist spacing="compact">
<listitem><para>Download (HTTP): <ulink url="&doxygen-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink url="&doxygen-download-ftp;"/></para></listitem>
<listitem><para>Download size: &doxygen-size;</para></listitem>
<listitem><para>Estimated disk space required: &doxygen-buildsize;</para></listitem>
<listitem><para>Estimated build time: &doxygen-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application>Doxygen</application> dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="qt"/>, 
<xref linkend="python"/>, 
<xref linkend="tex"/>, 
<xref linkend="gs"/> or <xref linkend="espgs"/>, and 
<ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Doxygen</application></title>

<para>Install <application>Doxygen</application> by running the following 
commands:</para>

<screen><userinput><command>rm src/unistd.h &amp;&amp;
./configure --prefix /usr --docdir /usr/share/doc &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

<para>If you wish to generate and install the package documentation, ensure 
the Python, TeX and Graphviz packages are installed, then substitute the 
following commands for the <command>make install</command> command above:</para>

<screen><userinput><command>make docs &amp;&amp;
make pdf &amp;&amp;
install -d -m755 /usr/share/doc/doxygen/src &amp;&amp;
install -m644 src/translator{,_adapter,_en}.h \
    /usr/share/doc/doxygen/src &amp;&amp;
install -m644 VERSION /usr/share/doc/doxygen &amp;&amp;
make install_docs</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>rm src/unistd.h</command>: There is a bug in 
<application>Flex</application>-2.5.31 which causes <command>make</command> to 
use this file instead of the system installed version. Removing this file 
allows the <acronym>GUI</acronym> front-end to build successfully.</para>

<para><option>--with-doxywizard</option>: Use this parameter if 
<application>Qt</application> is installed and you wish to build the 
<acronym>GUI</acronym> front-end.</para>

<para><command>make docs</command>: This command builds the 
<acronym>HTML</acronym> documentation.</para>

<para><command>make pdf</command>: This command builds a 
<acronym>PDF</acronym> version of the <application>Doxygen</application> 
Manual.</para>

<para><command>install ...</command>: These commands install some files 
required by the documentation installation.</para>

<para><emphasis>Note: For documentation in a language other than English, 
replace the <quote>_en</quote> with the country code of your 
locale.</emphasis></para>

<para><command>make install_docs</command>: This command installs the binaries 
and documentation.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>Doxygen</application> package contains 
<command>doxygen</command>, 
<command>doxytag</command> and optionally, 
<command>doxywizard</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>doxygen</title>
<para><command>doxygen</command> is a command-line based utility used to 
generate template configuration files and then generate documentation from 
these templates. Use <command>doxygen --help</command> for an explanation of 
the command-line parameters.</para></sect3>

<sect3><title>doxytag</title>
<para><command>doxytag</command> is used to generate a tag file and/or a 
search index for a set of <acronym>HTML</acronym> files.</para></sect3>

<sect3><title>doxywizard</title>
<para><command>doxywizard</command> is a <acronym>GUI</acronym> front-end for 
configuring and running <command>doxygen</command>.</para></sect3>

</sect2>

</sect1>