source: general/genutils/gtk-doc.xml@ c48b85a1

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since c48b85a1 was c48b85a1, checked in by Douglas R. Reno <renodr@…>, 2 years ago

Update to newt-0.52.21
telepathy-glib: Style improvement
gtk-doc: Typo fix
geocode-glib: style improvement
gnome-desktop: Fix typo in test descriptions for SysV, add comment about needing to add -Dgnome_distributor= to SysV when Elogind drops

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21736 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 5.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.xz">
8 <!ENTITY gtk-doc-download-ftp "&gnome-download-ftp;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.xz">
9 <!ENTITY gtk-doc-md5sum "1045ba29ca0693ced2045523407aae4c">
10 <!ENTITY gtk-doc-size "740 KB">
11 <!ENTITY gtk-doc-buildsize "17 MB (with tests)">
12 <!ENTITY gtk-doc-time "0.2 SBU (with tests)">
13]>
14
15<sect1 id="gtk-doc" xreflabel="GTK-Doc-&gtk-doc-version;">
16 <?dbhtml filename="gtk-doc.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>GTK-Doc-&gtk-doc-version;</title>
24
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>
31
32 <para>The <application>GTK-Doc</application> package
33 contains a code documenter. This is useful for extracting specially formatted
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
38 available, the install process will copy any pre-built documentation to your
39 system.</para>
40
41 &lfs84_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>Download (HTTP): <ulink url="&gtk-doc-download-http;"/></para>
47 </listitem>
48 <listitem>
49 <para>Download (FTP): <ulink url="&gtk-doc-download-ftp;"/></para>
50 </listitem>
51 <listitem>
52 <para>Download MD5 sum: &gtk-doc-md5sum;</para>
53 </listitem>
54 <listitem>
55 <para>Download size: &gtk-doc-size;</para>
56 </listitem>
57 <listitem>
58 <para>Estimated disk space required: &gtk-doc-buildsize;</para>
59 </listitem>
60 <listitem>
61 <para>Estimated build time: &gtk-doc-time;</para>
62 </listitem>
63 </itemizedlist>
64
65 <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
66
67 <bridgehead renderas="sect4">Recommended</bridgehead>
68 <para role="recommended">
69 <xref role="runtime" linkend="pygments"/> at run time
70 </para>
71
72 <bridgehead renderas="sect4">Required</bridgehead>
73 <para role="required">
74 <xref linkend="DocBook"/>,
75 <xref linkend="docbook-xsl"/>,
76 <xref linkend="itstool"/>, and
77 <xref linkend="libxslt"/>
78 </para>
79
80 <bridgehead renderas="sect4">Optional</bridgehead>
81 <para role="optional">
82 For tests:
83 <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
84 <xref linkend="fop"/> (XML PDF support),
85 <xref linkend="glib2"/>,
86 <xref linkend="which"/>, and
87 Python modules
88 <ulink url="https://anytree.readthedocs.io/en/latest/">anytree</ulink>, and
89 <ulink url="https://pypi.org/project/parameterized/">parameterized</ulink>
90 </para>
91
92 <note><para>The optional python modules above can be easily installed with
93 the <command>pip3</command> command.</para></note>
94
95 <para condition="html" role="usernotes">User Notes:
96 <ulink url="&blfs-wiki;/gtk-doc"/></para>
97
98 </sect2>
99
100 <sect2 role="installation">
101 <title>Installation of GTK-Doc</title>
102
103 <para>Install <application>GTK-Doc</application> by running
104 the following commands:</para>
105
106<screen><userinput>./configure --prefix=/usr &amp;&amp;
107make</userinput></screen>
108
109 <para>To test the results, issue: <command>make check</command>.
110 Some tests will fail depending on optionally installed packages.</para>
111
112 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
113
114<screen role="root"><userinput>make install</userinput></screen>
115
116 </sect2>
117
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>
125
126 <seglistitem>
127 <seg>
128 gtkdocize,
129 gtkdoc-check,
130 gtkdoc-depscan,
131 gtkdoc-fixxref,
132 gtkdoc-mkdb,
133 gtkdoc-mkhtml,
134 gtkdoc-mkhtml2,
135 gtkdoc-mkman,
136 gtkdoc-mkpdf,
137 gtkdoc-rebase,
138 gtkdoc-scan, and
139 gtkdoc-scangobj
140 </seg>
141
142 <seg>None</seg>
143
144 <seg>
145 /usr/share/gtk-doc and
146 /usr/share/help/*/gtk-doc-manual
147 </seg>
148 </seglistitem>
149 </segmentedlist>
150
151 <variablelist>
152 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
153 <?dbfo list-presentation="list"?>
154 <?dbhtml list-presentation="table"?>
155
156 <varlistentry id="gtkdoc">
157 <term><command>gtkdoc*</command></term>
158 <listitem>
159 <para>these are all shell, or
160 <application>Python</application> scripts used by
161 package <filename>Makefile</filename> scripts to generate
162 documentation for the package being built.</para>
163 <indexterm zone="gtk-doc gtkdoc">
164 <primary sortas="b-gtkdoc*">gtkdoc*</primary>
165 </indexterm>
166 </listitem>
167 </varlistentry>
168
169 </variablelist>
170
171 </sect2>
172
173</sect1>
Note: See TracBrowser for help on using the repository browser.