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