source: gnome/lib/gtk-doc/gtk-doc-intro.xml@ 8c986cd

<sect2>
<title>Introduction to <application><acronym>GTK</acronym>-Doc</application></title>

<para>The <application><acronym>GTK</acronym>-Doc</application> package contains a code documentor. This is useful for
extracting specially formatted comments from the code to create
<acronym>API</acronym>
documentation.  This package is <emphasis>optional</emphasis>, if it is not
installed, packages will not build the documentation. This does not mean
that you will not have any documentation, if <application><acronym>GTK</acronym>-Doc</application> is not available, the
install process will copy pre-built documentation to your system.
</para>

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

<!-- <sect3><title>Additional downloads:</title>
<itemizedlist spacing='compact'>
<listitem><para>Required download:</para></listitem>
<listitem><para><ulink
url="http://www.labs.redhat.com/png/png-support-3.1.dtd">png-support-3.1.dtd</ulink></para></listitem></itemizedlist></sect3> -->

<sect3><title><application><application><acronym>GTK</acronym>-Doc</application></application> dependencies</title>
<sect4><title>Required</title>
<para>
<xref linkend="openjade"/>,
<xref linkend="libxslt"/>,
<xref linkend="DocBook"/> and
<xref linkend="docbook-xsl"/>
<!--
<xref linkend="sgml-dtd-3"/>,
<xref linkend="sgml-dtd"/> and
<xref linkend="docbook-dsssl"/>
-->
</para></sect4>
</sect3>

</sect2>