source: gnome/lib/gtk-doc/gtk-doc-intro.xml@ 4407e93

10.0 10.1 11.0 6.0 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb v1_0 v5_0 v5_0-pre1 v5_1 v5_1-pre1 xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 4407e93 was 4407e93, checked in by Larry Lawrence <larry@…>, 19 years ago

cleanup links

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

  • Property mode set to 100644
File size: 1.5 KB
Line 
1<sect2>
2<title>Introduction to gtk-doc</title>
3
4<screen>Download location (HTTP): <ulink url="&gtk-doc-download-http;"/>
5Download location (FTP): <ulink url="&gtk-doc-download-ftp;"/>
6Version used: &gtk-doc-version;
7Package size: &gtk-doc-size;
8Estimated Disk space required: &gtk-doc-buildsize;</screen>
9
10<para>The gtk-doc package contains a code documentor. This is useful for
11extracting specially-formatted comments from the code to create API
12documentation. This package is <emphasis>optional</emphasis>, if it is not
13installed, packages will not build the documentation. If you choose to
14install this package, you will need to follow the hint titled <ulink
15url="http://hints.linuxfromscratch.org/hints/docbook.txt">Installing
16Docbook DTDs and Tools</ulink> to centralize the catalogs, add
17additional dtd's and dsssl templates and install openjade. If
18sgml-common will not install:</para>
19
20<screen>ln -s /usr/share/automake-1.6 /usr/share/automake</screen>
21
22<para>You also need to add dtd v3.0 to your collection, and finally, you need to modify dtd-3.1 by adding <ulink url="http:www.labs.redhat.com/png/png-support.html">png-support-3.1.dtd</ulink> to <filename>/usr/share/sgml/docbook/sgml-dtd-3.1</filename> and placing:</para>
23
24<screen>PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"</screen>
25
26<para>into the DocBook driver file section of
27<filename>/usr/share/sgml/docbook/sgml-dtd-3.1/catalog</filename>.</para>
28
29<screen>gtk-doc depends on:
30OpenJade</screen>
31
32</sect2>
Note: See TracBrowser for help on using the repository browser.