[fdca4266] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.2/gtk-doc->k-doc-version;.tar.bz2">
|
---|
| 8 | <!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.2/gtk-doc->k-doc-version;.tar.bz2">
|
---|
[4739ff5] | 9 | <!ENTITY gtk-doc-md5sum "7776ad690ca6baaaf071c83b51d2a234">
|
---|
[fdca4266] | 10 | <!ENTITY gtk-doc-size "132 KB">
|
---|
[4739ff5] | 11 | <!ENTITY gtk-doc-buildsize "1.1 MB">
|
---|
[fdca4266] | 12 | <!ENTITY gtk-doc-time "0.01 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
[a294e133] | 15 | <sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
---|
[a0f03b0] | 16 | <sect1info>
|
---|
[5cd0959d] | 17 | <othername>$LastChangedBy$</othername>
|
---|
| 18 | <date>$Date$</date>
|
---|
[a0f03b0] | 19 | </sect1info>
|
---|
[dd3f20f0] | 20 | <?dbhtml filename="gtk-doc.html"?>
|
---|
[a294e133] | 21 | <title>GTK-Doc->k-doc-version;</title>
|
---|
[832650c] | 22 |
|
---|
[fdca4266] | 23 | <sect2>
|
---|
[7207056] | 24 | <title>Introduction to <application><acronym>GTK</acronym>-Doc</application>
|
---|
| 25 | </title>
|
---|
[fdca4266] | 26 |
|
---|
[7207056] | 27 | <para>The <application><acronym>GTK</acronym>-Doc</application> package
|
---|
| 28 | contains a code documentor. This is useful for extracting specially formatted
|
---|
| 29 | comments from the code to create <acronym>API</acronym> documentation. This
|
---|
| 30 | package is <emphasis>optional</emphasis>; if it is not installed, packages will
|
---|
| 31 | not build the documentation. This does not mean that you will not have any
|
---|
| 32 | documentation. If <application><acronym>GTK</acronym>-Doc</application> is not
|
---|
| 33 | available, the install process will copy pre-built documentation to your system.
|
---|
[fdca4266] | 34 | </para>
|
---|
| 35 |
|
---|
| 36 | <sect3><title>Package information</title>
|
---|
| 37 | <itemizedlist spacing='compact'>
|
---|
| 38 | <listitem><para>Download (HTTP): <ulink
|
---|
| 39 | url=">k-doc-download-http;"/></para></listitem>
|
---|
| 40 | <listitem><para>Download (FTP): <ulink
|
---|
| 41 | url=">k-doc-download-ftp;"/></para></listitem>
|
---|
[4739ff5] | 42 | <listitem><para>MD5 sum: >k-doc-md5sum;</para></listitem>
|
---|
[fdca4266] | 43 | <listitem><para>Download size: >k-doc-size;</para></listitem>
|
---|
[4739ff5] | 44 | <listitem><para>Estimated disk space required:
|
---|
[fdca4266] | 45 | >k-doc-buildsize;</para></listitem>
|
---|
| 46 | <listitem><para>Estimated build time:
|
---|
| 47 | >k-doc-time;</para></listitem></itemizedlist>
|
---|
| 48 | </sect3>
|
---|
| 49 |
|
---|
[7207056] | 50 | <sect3><title><application><acronym>GTK</acronym>-Doc</application>
|
---|
| 51 | dependencies</title>
|
---|
[fdca4266] | 52 | <sect4><title>Required</title>
|
---|
[4739ff5] | 53 | <para><xref linkend="openjade"/>,
|
---|
| 54 | <xref linkend="libxslt"/>,
|
---|
| 55 | <xref linkend="DocBook"/> and
|
---|
| 56 | <xref linkend="docbook-xsl"/></para>
|
---|
| 57 | </sect4>
|
---|
[fdca4266] | 58 | </sect3>
|
---|
| 59 |
|
---|
| 60 | </sect2>
|
---|
| 61 |
|
---|
| 62 | <sect2>
|
---|
[7207056] | 63 | <title>Installation of <application><acronym>GTK</acronym>-Doc</application>
|
---|
| 64 | </title>
|
---|
[fdca4266] | 65 |
|
---|
[7207056] | 66 | <para>Install <application><acronym>GTK</acronym>-Doc</application> by running
|
---|
| 67 | the following commands:</para>
|
---|
[fdca4266] | 68 |
|
---|
| 69 | <screen><userinput><command>./configure --prefix=/usr &&
|
---|
| 70 | make install</command></userinput></screen>
|
---|
| 71 |
|
---|
| 72 | </sect2>
|
---|
| 73 |
|
---|
| 74 | <sect2>
|
---|
| 75 | <title>Contents</title>
|
---|
| 76 |
|
---|
[4739ff5] | 77 | <para>The <application><acronym>GTK</acronym>-Doc</application>
|
---|
| 78 | package contains
|
---|
| 79 | <command>gtkdoc-fixxref</command>,
|
---|
| 80 | <command>gtkdoc-mkdb</command>,
|
---|
| 81 | <command>gtkdoc-mkhtml</command>,
|
---|
| 82 | <command>gtkdoc-mkman</command>,
|
---|
| 83 | <command>gtkdoc-mktmpl</command>,
|
---|
| 84 | <command>gtkdoc-scan</command>,
|
---|
| 85 | <command>gtkdoc-scangobj</command>,
|
---|
| 86 | <command>gtkdoc-scanobj</command> and
|
---|
| 87 | <command>gtkdocize</command>.</para>
|
---|
[fdca4266] | 88 |
|
---|
| 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2><title>Description</title>
|
---|
| 92 |
|
---|
[4739ff5] | 93 | <para>These are all <application>Perl</application> scripts used by
|
---|
| 94 | <filename>Makefile</filename> scripts to generate documentation for the
|
---|
| 95 | package being built.</para>
|
---|
[fdca4266] | 96 |
|
---|
| 97 | </sect2>
|
---|
[832650c] | 98 |
|
---|
| 99 | </sect1>
|
---|
| 100 |
|
---|