2002-08-28 11:03:55 +08:00
|
|
|
<sect2>
|
|
|
|
<title>Introduction to gtk-doc</title>
|
|
|
|
|
|
|
|
<screen>Download location (HTTP): <ulink url=">k-doc-download-http;"/>
|
|
|
|
Download location (FTP): <ulink url=">k-doc-download-ftp;"/>
|
|
|
|
Version used: >k-doc-version;
|
|
|
|
Package size: >k-doc-size;
|
|
|
|
Estimated Disk space required: >k-doc-buildsize;</screen>
|
|
|
|
|
2003-01-03 12:12:34 +08:00
|
|
|
<screen>Additional downloads:
|
|
|
|
<ulink url="http://www.labs.redhat.com/png/png-support-3.1.dtd">png-support-3.1.dtd</ulink>
|
|
|
|
</screen>
|
|
|
|
|
2002-08-28 11:03:55 +08:00
|
|
|
<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-01-22 03:46:42 +08:00
|
|
|
that you will not have any documentation, if gtk-doc is not available, the
|
|
|
|
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
|
|
|
|
|
|
|
<screen>gtk-doc depends on:
|
2003-04-22 23:42:52 +08:00
|
|
|
<xref linkend="openjade"/>, <xref linkend="libxslt"/>, <xref linkend="DocBook"/>,
|
|
|
|
<xref linkend="sgml-dtd-3"/> and <xref linkend="sgml-dtd"/></screen>
|
2002-08-28 11:03:55 +08:00
|
|
|
|
|
|
|
</sect2>
|