The GTK-Doc package contains a code documenter. This is useful for extracting specially formatted comments from the code to create API documentation. This package is optional; if it is not installed, packages will not build the documentation. This does not mean that you will not have any documentation. If GTK-Doc is not available, the install process will copy any pre-built documentation to your system.
This package is known to build and work properly using an LFS-7.0 platform.
Download (HTTP): http://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.18/gtk-doc-1.18.tar.xz
Download (FTP): ftp://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.18/gtk-doc-1.18.tar.xz
Download MD5 sum: 3927bed60fdd0fc9093a1d00018e746a
Download size: 628 KB
Estimated disk space required: 10 MB
Estimated build time: 0.2 SBU
DocBook XML DTD-4.5, DocBook XSL Stylesheets-1.76.1, and libxslt-1.1.26
GLib-2.30.1 (for the testsuite), dblatex or FOP-1.0 (XML PDF support), GNOME Doc Utils-0.20.2 and which-2.20 (builds gtk-doc documentation), OpenJade-1.3.2 with DocBook SGML DTD-4.5 and DocBook DSSSL Stylesheets-1.79 (SGML support, not actively maintained any more), Python-2.7.2 (builds gtkdoc-depscan), and Rarian-0.8.1
User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc
Install GTK-Doc by running the following commands:
sed -i 's/wa!/w! $temp_source_file.html/' gtkdoc-fixxref.in \ ./configure --prefix=/usr \ --disable-scrollkeeper && make
To test the results, issue: make check.
Now, as the root
user:
make install
--disable-scrollkeeper
: Do
not make updates to the scrollkeeper database. Remove it if you have
rarian installed.
sed -i '...' gtkdoc-fixxref.in: This command fixes an issue where invocations of the Vim editor does not behave as expected. See upstream bug at https://bugzilla.gnome.org/show_bug.cgi?id=627223.
Last updated on 2011-12-14 18:32:19 +0000