[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[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 |
|
---|
[8d45c9a] | 7 | <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/>k-doc-major;/gtk-doc->k-doc-version;.tar.xz">
|
---|
[e1e58be] | 8 | <!ENTITY gtk-doc-download-ftp " ">
|
---|
[6306f35] | 9 | <!ENTITY gtk-doc-md5sum "f0e7385ba25eddb6ce0953e8cf63d1bf">
|
---|
| 10 | <!ENTITY gtk-doc-size "484 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 |
|
---|
| 18 |
|
---|
[effdc6af] | 19 | <title>GTK-Doc->k-doc-version;</title>
|
---|
[fc7afd0c] | 20 |
|
---|
[effdc6af] | 21 | <indexterm zone="gtk-doc">
|
---|
| 22 | <primary sortas="a-GTK-Doc">GTK-Doc</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to GTK-Doc</title>
|
---|
[fc7afd0c] | 27 |
|
---|
[b7a85cd9] | 28 | <para>
|
---|
| 29 | The <application>GTK-Doc</application> package contains a code
|
---|
| 30 | documenter. This is useful for extracting specially formatted comments
|
---|
| 31 | from the code to create API documentation. This package is
|
---|
| 32 | <emphasis>optional</emphasis>; if it is not installed, packages will
|
---|
| 33 | not build the documentation. This does not mean that you will not have
|
---|
| 34 | any documentation. If <application>GTK-Doc</application> is not
|
---|
| 35 | available, the install process will copy any pre-built documentation
|
---|
| 36 | to your system.
|
---|
| 37 | </para>
|
---|
[fc7afd0c] | 38 |
|
---|
[3c9b5e9] | 39 | &lfs122_checked;
|
---|
[a10f4a7] | 40 |
|
---|
[effdc6af] | 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
[b7a85cd9] | 44 | <para>
|
---|
| 45 | Download (HTTP): <ulink url=">k-doc-download-http;"/>
|
---|
| 46 | </para>
|
---|
[effdc6af] | 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
[b7a85cd9] | 49 | <para>
|
---|
| 50 | Download (FTP): <ulink url=">k-doc-download-ftp;"/>
|
---|
| 51 | </para>
|
---|
[effdc6af] | 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
[b7a85cd9] | 54 | <para>
|
---|
| 55 | Download MD5 sum: >k-doc-md5sum;
|
---|
| 56 | </para>
|
---|
[effdc6af] | 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[b7a85cd9] | 59 | <para>
|
---|
| 60 | Download size: >k-doc-size;
|
---|
| 61 | </para>
|
---|
[effdc6af] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[b7a85cd9] | 64 | <para>
|
---|
| 65 | Estimated disk space required: >k-doc-buildsize;
|
---|
| 66 | </para>
|
---|
[effdc6af] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[b7a85cd9] | 69 | <para>
|
---|
| 70 | Estimated build time: >k-doc-time;
|
---|
| 71 | </para>
|
---|
[effdc6af] | 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
[7199a09] | 74 | <!--
|
---|
[ddd5a70] | 75 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 76 | <itemizedlist spacing="compact">
|
---|
| 77 | <listitem>
|
---|
| 78 | <para>
|
---|
| 79 | Required patch to allow building <xref linkend="glib2"/>
|
---|
| 80 | documentation:
|
---|
| 81 | <ulink url="&patch-root;/gtk-doc->k-doc-version;-glib2_fixes-1.patch"/>
|
---|
| 82 | </para>
|
---|
| 83 | </listitem>
|
---|
| 84 | </itemizedlist>
|
---|
[7199a09] | 85 | -->
|
---|
[effdc6af] | 86 | <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
|
---|
[fc7afd0c] | 87 |
|
---|
[effdc6af] | 88 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[ba056d7] | 89 | <para role="required">
|
---|
| 90 | <xref linkend="DocBook"/>,
|
---|
| 91 | <xref linkend="docbook-xsl"/>,
|
---|
[b5db82fe] | 92 | <xref linkend="glib2"/>,
|
---|
| 93 | <xref linkend="itstool"/>,
|
---|
| 94 | <xref linkend="libxslt"/>, and
|
---|
| 95 | <xref linkend="pygments"/>
|
---|
[ba056d7] | 96 | </para>
|
---|
[b5db82fe] | 97 | <!--
|
---|
[9d10790] | 98 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 99 | <para role="recommended">
|
---|
| 100 | <xref role="runtime" linkend="pygments"/> at run time
|
---|
| 101 | </para>
|
---|
[b5db82fe] | 102 | -->
|
---|
[effdc6af] | 103 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b495000] | 104 | <para role="optional">
|
---|
[8558044] | 105 | For tests:
|
---|
[c6b192c] | 106 | <ulink url="https://sourceforge.net/projects/dblatex/">dblatex</ulink> or
|
---|
[665ac79f] | 107 | <xref linkend="fop"/> (XML PDF support),
|
---|
[b7279d4] | 108 | <xref linkend="glib2"/>,
|
---|
| 109 | <xref linkend="which"/>, and
|
---|
[8558044] | 110 | Python modules
|
---|
[ad112fd5] | 111 | <xref linkend="lxml"/>,
|
---|
[c3447c89] | 112 | <!--<ulink url="https://anytree.readthedocs.io/en/latest/">anytree</ulink>,-->
|
---|
[f455d4a] | 113 | <ulink url="https://pypi.org/project/parameterized/">parameterized</ulink>,
|
---|
| 114 | and <ulink url="&gnome-download-http;/yelp-tools">yelp-tools</ulink>
|
---|
[665ac79f] | 115 | </para>
|
---|
[fc7afd0c] | 116 |
|
---|
[b7a85cd9] | 117 | <note>
|
---|
| 118 | <para>
|
---|
| 119 | The optional python modules above can be easily installed with
|
---|
| 120 | the <command>pip3</command> command.
|
---|
| 121 | </para>
|
---|
| 122 | </note>
|
---|
[b7279d4] | 123 |
|
---|
[1039de3] | 124 |
|
---|
[effdc6af] | 125 | </sect2>
|
---|
[fc7afd0c] | 126 |
|
---|
[effdc6af] | 127 | <sect2 role="installation">
|
---|
| 128 | <title>Installation of GTK-Doc</title>
|
---|
| 129 |
|
---|
[b7a85cd9] | 130 | <para>
|
---|
| 131 | Install <application>GTK-Doc</application> by running
|
---|
| 132 | the following commands:
|
---|
| 133 | </para>
|
---|
[effdc6af] | 134 |
|
---|
[6306f35] | 135 | <screen><userinput>mkdir -p build &&
|
---|
| 136 | cd build &&
|
---|
| 137 |
|
---|
| 138 | meson setup --prefix=/usr --buildtype=release .. &&
|
---|
| 139 | ninja</userinput></screen>
|
---|
[2e46c65] | 140 |
|
---|
[b7a85cd9] | 141 | <para>
|
---|
[8558044] | 142 | The test suite will hang if the package (or a previous version)
|
---|
[b7a85cd9] | 143 | is not already installed.
|
---|
| 144 | </para>
|
---|
[0e5a229a] | 145 |
|
---|
[b7a85cd9] | 146 | <para>
|
---|
| 147 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 148 | </para>
|
---|
[fc7afd0c] | 149 |
|
---|
[6306f35] | 150 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[fc7afd0c] | 151 |
|
---|
[b7a85cd9] | 152 | <para>
|
---|
[6306f35] | 153 | To test the results, issue: <command>ninja test</command>.
|
---|
[b7a85cd9] | 154 | Some tests will fail depending on optionally installed packages.
|
---|
[8558044] | 155 | </para>
|
---|
[ad112fd5] | 156 |
|
---|
[effdc6af] | 157 | </sect2>
|
---|
[fc7afd0c] | 158 |
|
---|
[effdc6af] | 159 | <sect2 role="content">
|
---|
| 160 | <title>Contents</title>
|
---|
| 161 |
|
---|
| 162 | <segmentedlist>
|
---|
| 163 | <segtitle>Installed Programs</segtitle>
|
---|
| 164 | <segtitle>Installed Libraries</segtitle>
|
---|
| 165 | <segtitle>Installed Directories</segtitle>
|
---|
[fc7afd0c] | 166 |
|
---|
[effdc6af] | 167 | <seglistitem>
|
---|
[b7279d4] | 168 | <seg>
|
---|
| 169 | gtkdocize,
|
---|
[8558044] | 170 | gtkdoc-check,
|
---|
| 171 | gtkdoc-depscan,
|
---|
[b7279d4] | 172 | gtkdoc-fixxref,
|
---|
[8558044] | 173 | gtkdoc-mkdb,
|
---|
| 174 | gtkdoc-mkhtml,
|
---|
| 175 | gtkdoc-mkhtml2,
|
---|
| 176 | gtkdoc-mkman,
|
---|
[b7279d4] | 177 | gtkdoc-mkpdf,
|
---|
[8558044] | 178 | gtkdoc-rebase,
|
---|
| 179 | gtkdoc-scan, and
|
---|
[b7279d4] | 180 | gtkdoc-scangobj
|
---|
| 181 | </seg>
|
---|
[8558044] | 182 |
|
---|
[effdc6af] | 183 | <seg>None</seg>
|
---|
[8558044] | 184 |
|
---|
[b7279d4] | 185 | <seg>
|
---|
| 186 | /usr/share/gtk-doc and
|
---|
[7199a09] | 187 | /usr/share/cmake/GtkDoc
|
---|
[c1add1f5] | 188 | </seg>
|
---|
[effdc6af] | 189 | </seglistitem>
|
---|
| 190 | </segmentedlist>
|
---|
[fc7afd0c] | 191 |
|
---|
[effdc6af] | 192 | <variablelist>
|
---|
| 193 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 194 | <?dbfo list-presentation="list"?>
|
---|
| 195 | <?dbhtml list-presentation="table"?>
|
---|
[fc7afd0c] | 196 |
|
---|
[effdc6af] | 197 | <varlistentry id="gtkdoc">
|
---|
| 198 | <term><command>gtkdoc*</command></term>
|
---|
| 199 | <listitem>
|
---|
[b7a85cd9] | 200 | <para>
|
---|
[8558044] | 201 | these are all shell, or
|
---|
[b7a85cd9] | 202 | <application>Python</application> scripts used by
|
---|
| 203 | package <filename>Makefile</filename> scripts to generate
|
---|
[4c24eb0a] | 204 | documentation for the package being built
|
---|
[b7a85cd9] | 205 | </para>
|
---|
[effdc6af] | 206 | <indexterm zone="gtk-doc gtkdoc">
|
---|
| 207 | <primary sortas="b-gtkdoc*">gtkdoc*</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
[fc7afd0c] | 211 |
|
---|
[effdc6af] | 212 | </variablelist>
|
---|
[fc7afd0c] | 213 |
|
---|
[effdc6af] | 214 | </sect2>
|
---|
[fc7afd0c] | 215 |
|
---|
[832650c] | 216 | </sect1>
|
---|