GTK-Doc-1.18

Introduction à GTK-Doc

Le paquet GTK-Doc contient un documentateur de code. C'est utile pour extraire des commentaires spécialement formatés du code pour créer des documentations d'API. Ce paquet est facultatif ; si vous ne l'installez pas, les paquets ne construiront pas la documentation. Cela ne veut pas dire que vous n'aurez aucune documentation. Si GTK-Doc n'est pas disponible, le processus d'installation copiera toute la documentation préconstruite sur votre système.

Ce paquet est connu pour se construire et fonctionner correctement sur une plateforme LFS-7.0.

Informations sur le paquet

Dépendances de GTK-Doc

Requises

DocBook XML DTD-4.5, DocBook XSL Stylesheets-1.76.1, et libxslt-1.1.26

Facultatives

GLib-2.30.1 (for the testsuite), dblatex or FOP-1.0 (XML PDF support), GNOME Doc Utils-0.20.2 et which-2.20 (construit la documentation gtk-doc), OpenJade-1.3.2 avec DocBook SGML DTD-4.5 et DocBook DSSSL Stylesheets-1.79 (support SGML, il n'est plus maintenu activement), Python-2.7.2 (construit gtkdoc-depscan), et Rarian-0.8.1

Notes utilisateur : http://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc

Installation de GTK-Doc

Installez GTK-Doc dn lançant les commandes suivantes :

sed -i 's/wa!/w! $temp_source_file.html/' gtkdoc-fixxref.in \
./configure --prefix=/usr  \
            --disable-scrollkeeper &&
make

Pour tester les résultats, lancez : make check.

Maintenant, en tant qu'utilisateur root :

make install

Explication de la commande

--disable-scrollkeeper : N'effectue pas des mises à jour vers la base de données scrollkeeper. Supprimez-la si vous avez installé rarian.

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.

Contenu

Programmes installés: gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdocize, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-mktmpl, gtkdoc-rebase, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj
Bibliothèques installées: Aucune
Répertoires installés: /usr/share/{gnome/help/gtk-doc-manual/*,gtk-doc/data,omf/gtk-doc-manual,sgml/gtk-doc}

Descriptions courtes

gtkdoc*

ce sont tout des scripts shell, Perl, ou Python utilisés par les scripts Makefile du paquet pour générer la documentation du paquet qui va être construit.

Last updated on 2011-12-14 19:32:19 +0100