source: general/genutils/gtk-doc.xml@ 7f76b96

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

<!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.2/gtk-doc-&gtk-doc-version;.tar.bz2">
<!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.2/gtk-doc-&gtk-doc-version;.tar.bz2">
<!ENTITY gtk-doc-md5sum "7776ad690ca6baaaf071c83b51d2a234">
<!ENTITY gtk-doc-size "132 KB">
<!ENTITY gtk-doc-buildsize "1.1 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>

<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>
</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 &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application><acronym>GTK</acronym>-Doc</application> 
package contains 
<command>gtkdoc-fixxref</command>, 
<command>gtkdoc-mkdb</command>, 
<command>gtkdoc-mkhtml</command>, 
<command>gtkdoc-mkman</command>, 
<command>gtkdoc-mktmpl</command>, 
<command>gtkdoc-scan</command>, 
<command>gtkdoc-scangobj</command>, 
<command>gtkdoc-scanobj</command> and 
<command>gtkdocize</command>.</para>

</sect2>

<sect2><title>Description</title>

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

</sect2>

</sect1>