Difference between revisions of "Gtk-Doc"

From CBLFS
Jump to navigationJump to search
(→‎Introduction to GTK-Doc)
Line 9: Line 9:
 
== Introduction to GTK-Doc ==
 
== Introduction to GTK-Doc ==
  
−
The GTK-Doc package contains a code documentor. 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.
+
<Package Description Needed>
  
 
== Dependencies ==
 
== Dependencies ==

Revision as of 22:09, 11 January 2007

Download Source: http://ftp.gnome.org/pub/gnome/sources/gtk-doc/1.11/gtk-doc-1.11.tar.bz2

Introduction to GTK-Doc

<Package Description Needed>

Dependencies

Required

Optional

Non-Multilib or Multilib

Compile the package: 

./configure --prefix=/usr --localstatedir=/var/lib &&
make

Install the package 

make install

Command Explanations

--localstatedir=/var/lib: This parameter is used so that all ScrollKeeper files are installed in, and the ScrollKeeper database is properly updated in /var/lib/scrollkeeper instead of some files being installed in $GNOME_PREFIX/var/scrollkeeper.

Contents

Installed Programs: gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj
Installed Libraries: None
Installed Directories: The following subdirectories of /usr/share/: doc/gtk-doc-1.11., gnome/help/gtk-doc-manual, gtk-doc/data and {omf,sgml}/gtk-doc

Short Descriptions

gtkdoc* these are all Perl scripts used by package Makefile scripts to generate documentation for the package being built.
Retrieved from "?title=Gtk-Doc&oldid=6917"