source: general/genutils/gtk-doc.xml@ 46ddda21

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
<!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
<!ENTITY gtk-doc-md5sum "d105d5b28e7e023ab1b7e85fb65e45c3">
<!ENTITY gtk-doc-size "145 KB">
<!ENTITY gtk-doc-buildsize "1.6 MB">
<!ENTITY gtk-doc-time "0.01 SBU">
]>

<sect1 id="gtk-doc" xreflabel="GTK-Doc-&gtk-doc-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="gtk-doc.html"?>
<title>GTK-Doc-&gtk-doc-version;</title>
<indexterm zone="gtk-doc">
<primary sortas="a-GTK-Doc">GTK-Doc</primary></indexterm>

<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 MD5 sum: &gtk-doc-md5sum;</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><application><acronym>GTK</acronym>-Doc</application> 
dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="openjade"/>, 
<xref linkend="libxslt"/>, 
<xref linkend="DocBook"/> and 
<xref linkend="docbook-xsl"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="sgml-dtd"/> and <xref linkend="docbook-dsssl"/></para>
</sect4>

</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>GTK</acronym>-Doc</application>
</title>

<para>Install <application><acronym>GTK</acronym>-Doc</application> by running 
the following commands:</para>

<screen><userinput><command>./configure --prefix=/usr</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>

<seglistitem>
<seg>gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, 
gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj and gtkdoc-scanobj</seg>
<seg>None</seg>
<seg>/usr/share/gtk-doc and /usr/share/sgml/gtk-doc</seg>
</seglistitem>
</segmentedlist>

<sect3><title> Short description</title>
<para>These are all <application>Perl</application> scripts used by 
package <filename>Makefile</filename> scripts to generate documentation for 
the package being built.</para>
</sect3>

</sect2>

</sect1>