glfs/gnome/lib/gtk-doc/gtk-doc-intro.xml

<sect2>
<title>Introduction to gtk-doc</title>

<screen>Download location (HTTP):       <ulink url="&gtk-doc-download-http;"/>
Download location (FTP):        <ulink url="&gtk-doc-download-ftp;"/>
Version used:                   &gtk-doc-version;
Package size:                   &gtk-doc-size;
Estimated Disk space required:  &gtk-doc-buildsize;</screen>

<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
installed, packages will not build the documentation. If you choose to
install this package, you will need to follow the hint titled <ulink
url="http://hints.linuxfromscratch.org/hints/docbook.txt">Installing
Docbook DTDs and Tools</ulink> to centralize the catalogs, add
additional dtd's and dsssl templates and install openjade. If
sgml-common will not install:</para>

<screen>ln -s /usr/share/automake-1.6 /usr/share/automake</screen>

<para>You also need to add dtd v3.0 to your collection, and finally, you need to modify dtd-3.1 by adding <ulink url="http:www.labs.redhat.com/png/png-support.html">png-support-3.1.dtd</ulink> to <filename>/usr/share/sgml/docbook/sgml-dtd-3.1</filename> and placing:</para>

<screen>PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"</screen>

<para>into the DocBook driver file section of
<filename>/usr/share/sgml/docbook/sgml-dtd-3.1/catalog</filename>.</para>

<screen>gtk-doc depends on:
OpenJade</screen>

</sect2>