1 | <sect2>
|
---|
2 | <title>Introduction to gtk-doc</title>
|
---|
3 |
|
---|
4 | <para>The gtk-doc package contains a code documentor. This is useful for
|
---|
5 | extracting specially-formatted comments from the code to create API
|
---|
6 | documentation. This package is <emphasis>optional</emphasis>, if it is not
|
---|
7 | installed, packages will not build the documentation. This does not mean
|
---|
8 | that you will not have any documentation, if gtk-doc is not available, the
|
---|
9 | install process will copy pre-built documentation to your system.
|
---|
10 | </para>
|
---|
11 |
|
---|
12 | <sect3><title>Package information</title>
|
---|
13 | <itemizedlist spacing='compact'>
|
---|
14 | <listitem><para>Download (HTTP): <ulink
|
---|
15 | url=">k-doc-download-http;"/></para></listitem>
|
---|
16 | <listitem><para>Download (FTP): <ulink
|
---|
17 | url=">k-doc-download-ftp;"/></para></listitem>
|
---|
18 | <listitem><para>Download size: >k-doc-size;</para></listitem>
|
---|
19 | <listitem><para>Estimated Disk space required:
|
---|
20 | >k-doc-buildsize;</para></listitem>
|
---|
21 | <listitem><para>Estimated build time:
|
---|
22 | >k-doc-time;</para></listitem></itemizedlist>
|
---|
23 | </sect3>
|
---|
24 |
|
---|
25 | <!-- <sect3><title>Additional downloads:</title>
|
---|
26 | <itemizedlist spacing='compact'>
|
---|
27 | <listitem><para>Required download:</para></listitem>
|
---|
28 | <listitem><para><ulink
|
---|
29 | url="http://www.labs.redhat.com/png/png-support-3.1.dtd">png-support-3.1.dtd</ulink></para></listitem></itemizedlist></sect3> -->
|
---|
30 |
|
---|
31 | <sect3><title><application>gtk-doc</application> dependencies</title>
|
---|
32 | <sect4><title>Required</title>
|
---|
33 | <para><xref linkend="openjade"/>, <xref linkend="libxslt"/>, <xref
|
---|
34 | linkend="DocBook"/>,
|
---|
35 | <xref linkend="sgml-dtd-3"/>, <xref linkend="sgml-dtd"/> and <xref
|
---|
36 | linkend="docbook-dsssl"/></para></sect4>
|
---|
37 | </sect3>
|
---|
38 |
|
---|
39 |
|
---|
40 | </sect2>
|
---|