Au-delà de Linux® From Scratch - Version 2012-11-01

Chapitre 11. Outils généraux

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 correctement sur une plateforme LFS-7.2.

Informations sur le paquet

Dépendances de GTK-Doc

Requises

DocBook XML-DTD-4.5, DocBook XSL Stylesheets-1.77.1, et libxslt-1.1.27

Recommandées

pkg-config-0.27.1 (pour utiliser certains deps facultatifs)

Facultatives

dblatex or fop-1.1 (XML PDF support), GLib-2.34.1 (pour la suite de tests), GNOME Doc-Utils-0.20.10 et which-2.20 (requis pour la suite de tests et pour 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.3 (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 : 

./configure --prefix=/usr &&
make

Ce paquet n'a pas de suite de tests opérationnelle.

Maintenant, en tant qu'utilisateur root : 

make install

Explication de la commande

sed -i '...' gtkdoc-fixxref.in : Cette commande corrige un problème lorsque l'invocation de l'éditeur Vim ne se comporte pas comme prévue. Voir le bogue en amont ici : 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 : 2012-08-14 16:33:42 +020