[fdca4266] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[fdca4266] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[6a513a4] | 7 | <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.xz">
|
---|
| 8 | <!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/>k-doc-version;/gtk-doc->k-doc-version;.tar.xz">
|
---|
[2e36dc7] | 9 | <!ENTITY gtk-doc-md5sum "b29949e0964762e474b706ce22171602">
|
---|
| 10 | <!ENTITY gtk-doc-size "704 KB">
|
---|
| 11 | <!ENTITY gtk-doc-buildsize "14 MB (with tests)">
|
---|
[c1add1f5] | 12 | <!ENTITY gtk-doc-time "0.2 SBU (with tests)">
|
---|
[fdca4266] | 13 | ]>
|
---|
| 14 |
|
---|
[a294e133] | 15 | <sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;">
|
---|
[effdc6af] | 16 | <?dbhtml filename="gtk-doc.html"?>
|
---|
[fc7afd0c] | 17 |
|
---|
[effdc6af] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[fc7afd0c] | 22 |
|
---|
[effdc6af] | 23 | <title>GTK-Doc->k-doc-version;</title>
|
---|
[fc7afd0c] | 24 |
|
---|
[effdc6af] | 25 | <indexterm zone="gtk-doc">
|
---|
| 26 | <primary sortas="a-GTK-Doc">GTK-Doc</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to GTK-Doc</title>
|
---|
[fc7afd0c] | 31 |
|
---|
[8d77de6] | 32 | <para>The <application>GTK-Doc</application> package
|
---|
[104733c] | 33 | contains a code documenter. This is useful for extracting specially formatted
|
---|
[8d77de6] | 34 | comments from the code to create API documentation. This
|
---|
| 35 | package is <emphasis>optional</emphasis>; if it is not installed, packages will
|
---|
| 36 | not build the documentation. This does not mean that you will not have any
|
---|
| 37 | documentation. If <application>GTK-Doc</application> is not
|
---|
[d9962703] | 38 | available, the install process will copy any pre-built documentation to your
|
---|
[effdc6af] | 39 | system.</para>
|
---|
[fc7afd0c] | 40 |
|
---|
[eab496c5] | 41 | &lfs82_checked;
|
---|
[a10f4a7] | 42 |
|
---|
[effdc6af] | 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (HTTP): <ulink url=">k-doc-download-http;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download (FTP): <ulink url=">k-doc-download-ftp;"/></para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download MD5 sum: >k-doc-md5sum;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download size: >k-doc-size;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated disk space required: >k-doc-buildsize;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Estimated build time: >k-doc-time;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | </itemizedlist>
|
---|
[fc7afd0c] | 64 |
|
---|
[effdc6af] | 65 | <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
---|
[fc7afd0c] | 66 |
|
---|
[effdc6af] | 67 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[ba056d7] | 68 | <para role="required">
|
---|
| 69 | <xref linkend="DocBook"/>,
|
---|
| 70 | <xref linkend="docbook-xsl"/>,
|
---|
[c1add1f5] | 71 | <xref linkend="itstool"/>,
|
---|
| 72 | <xref linkend="libxslt"/>, and
|
---|
| 73 | <xref linkend="python2"/>
|
---|
[ba056d7] | 74 | </para>
|
---|
[64c6acb] | 75 |
|
---|
[c90f683] | 76 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 77 | <para role="recommended">
|
---|
| 78 | <xref linkend="highlight"/>
|
---|
| 79 | </para>
|
---|
| 80 |
|
---|
[effdc6af] | 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b495000] | 82 | <para role="optional">
|
---|
[665ac79f] | 83 | <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
|
---|
| 84 | <xref linkend="fop"/> (XML PDF support),
|
---|
| 85 | <xref linkend="glib2"/> (for the test suite),
|
---|
[c1add1f5] | 86 | <ulink url="&gnome-download-http;/gnome-doc-utils/">GNOME Doc Utils</ulink> and
|
---|
| 87 | <xref linkend="which"/> (required for the test suite and gtk-doc documentation), and
|
---|
[75f9a0e3] | 88 | <xref linkend="six"/> (for some tests)
|
---|
[665ac79f] | 89 | </para>
|
---|
[fc7afd0c] | 90 |
|
---|
[505c46cc] | 91 | <bridgehead renderas="sect4">Required (runtime)</bridgehead>
|
---|
[1051f94e] | 92 | <para role="required">
|
---|
| 93 | <xref role="runtime" linkend="six"/>
|
---|
[505c46cc] | 94 | </para>
|
---|
| 95 |
|
---|
[1039de3] | 96 | <para condition="html" role="usernotes">User Notes:
|
---|
| 97 | <ulink url="&blfs-wiki;/gtk-doc"/></para>
|
---|
| 98 |
|
---|
[effdc6af] | 99 | </sect2>
|
---|
[fc7afd0c] | 100 |
|
---|
[effdc6af] | 101 | <sect2 role="installation">
|
---|
| 102 | <title>Installation of GTK-Doc</title>
|
---|
| 103 |
|
---|
[8d77de6] | 104 | <para>Install <application>GTK-Doc</application> by running
|
---|
[effdc6af] | 105 | the following commands:</para>
|
---|
| 106 |
|
---|
[f47c5167] | 107 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[2e46c65] | 108 | make</userinput></screen>
|
---|
| 109 |
|
---|
[5b9456bf] | 110 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
[0e5a229a] | 111 |
|
---|
[effdc6af] | 112 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[fc7afd0c] | 113 |
|
---|
[effdc6af] | 114 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[fc7afd0c] | 115 |
|
---|
[effdc6af] | 116 | </sect2>
|
---|
[fc7afd0c] | 117 |
|
---|
[effdc6af] | 118 | <sect2 role="content">
|
---|
| 119 | <title>Contents</title>
|
---|
| 120 |
|
---|
| 121 | <segmentedlist>
|
---|
| 122 | <segtitle>Installed Programs</segtitle>
|
---|
| 123 | <segtitle>Installed Libraries</segtitle>
|
---|
| 124 | <segtitle>Installed Directories</segtitle>
|
---|
[fc7afd0c] | 125 |
|
---|
[effdc6af] | 126 | <seglistitem>
|
---|
[c1add1f5] | 127 | <seg>gtkdocize,
|
---|
| 128 | gtkdoc-check,
|
---|
| 129 | gtkdoc-depscan,
|
---|
| 130 | gtkdoc-fixxref,
|
---|
| 131 | gtkdoc-mkdb,
|
---|
| 132 | gtkdoc-mkhtml,
|
---|
| 133 | gtkdoc-mkman,
|
---|
| 134 | gtkdoc-mkpdf,
|
---|
| 135 | gtkdoc-rebase,
|
---|
| 136 | gtkdoc-scan, and
|
---|
| 137 | gtkdoc-scangobj</seg>
|
---|
| 138 |
|
---|
[effdc6af] | 139 | <seg>None</seg>
|
---|
[c1add1f5] | 140 |
|
---|
| 141 | <seg>/usr/lib/cmake/GtkDoc,
|
---|
| 142 | /usr/share/gtk-doc, and
|
---|
| 143 | /usr/share/help/*/gtk-doc-manual
|
---|
| 144 | </seg>
|
---|
[effdc6af] | 145 | </seglistitem>
|
---|
| 146 | </segmentedlist>
|
---|
[fc7afd0c] | 147 |
|
---|
[effdc6af] | 148 | <variablelist>
|
---|
| 149 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 150 | <?dbfo list-presentation="list"?>
|
---|
| 151 | <?dbhtml list-presentation="table"?>
|
---|
[fc7afd0c] | 152 |
|
---|
[effdc6af] | 153 | <varlistentry id="gtkdoc">
|
---|
| 154 | <term><command>gtkdoc*</command></term>
|
---|
| 155 | <listitem>
|
---|
[c1add1f5] | 156 | <para>these are all shell, or
|
---|
[64c6acb] | 157 | <application>Python</application> scripts used by
|
---|
[8d77de6] | 158 | package <filename>Makefile</filename> scripts to generate
|
---|
[effdc6af] | 159 | documentation for the package being built.</para>
|
---|
| 160 | <indexterm zone="gtk-doc gtkdoc">
|
---|
| 161 | <primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
---|
| 162 | </indexterm>
|
---|
| 163 | </listitem>
|
---|
| 164 | </varlistentry>
|
---|
[fc7afd0c] | 165 |
|
---|
[effdc6af] | 166 | </variablelist>
|
---|
[fc7afd0c] | 167 |
|
---|
[effdc6af] | 168 | </sect2>
|
---|
[fc7afd0c] | 169 |
|
---|
[832650c] | 170 | </sect1>
|
---|