2002-08-28 11:03:55 +08:00
|
|
|
<sect2>
|
|
|
|
<title>Introduction to gtk-doc</title>
|
|
|
|
|
|
|
|
<para>The gtk-doc package contains a code documentor. This is useful for
|
|
|
|
extracting specially-formatted comments from the code to create API
|
|
|
|
documentation. This package is <emphasis>optional</emphasis>, if it is not
|
2002-10-03 07:11:53 +08:00
|
|
|
installed, packages will not build the documentation. This does not mean
|
2003-08-29 08:36:46 +08:00
|
|
|
that you will not have any documentation, if gtk-doc is not available, the
|
2003-01-22 03:46:42 +08:00
|
|
|
install process will copy pre-built documentation to your system.
|
2003-01-03 12:12:34 +08:00
|
|
|
</para>
|
2002-08-28 11:03:55 +08:00
|
|
|
|
2003-08-29 08:36:46 +08:00
|
|
|
<sect3><title>Package information</title>
|
|
|
|
<itemizedlist spacing='compact'>
|
|
|
|
<listitem><para>Download (HTTP): <ulink
|
|
|
|
url=">k-doc-download-http;"/></para></listitem>
|
|
|
|
<listitem><para>Download (FTP): <ulink
|
|
|
|
url=">k-doc-download-ftp;"/></para></listitem>
|
|
|
|
<listitem><para>Download size: >k-doc-size;</para></listitem>
|
|
|
|
<listitem><para>Estimated Disk space required:
|
|
|
|
>k-doc-buildsize;</para></listitem>
|
|
|
|
<listitem><para>Estimated build time:
|
|
|
|
>k-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>template</application> dependencies</title>
|
|
|
|
<sect4><title>Required</title>
|
|
|
|
<para><xref linkend="openjade"/>, <xref linkend="libxslt"/>, <xref
|
|
|
|
linkend="DocBook"/>,
|
|
|
|
<xref linkend="sgml-dtd-3"/> and <xref linkend="sgml-dtd"/></para></sect4>
|
|
|
|
</sect3>
|
|
|
|
|
2002-08-28 11:03:55 +08:00
|
|
|
|
|
|
|
</sect2>
|