Au-delà de Linux® From Scratch (édition systemd) - Version 8.4

Chapitre 11. Outils généraux

GTK-Doc-1.29

Introduction à GTK-Doc

Le paquet GTK-Doc permet de documenter du 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-8.4.

Informations sur le paquet

Dépendances de GTK-Doc

Requises

docbook-xml-4.5, docbook-xsl-1.79.2, itstool-2.0.5 et libxslt-1.1.33

Recommandées

Highlight-3.49

Facultatives

dblatex ou fop-2.3 (support de XML PDF), GLib-2.58.3 (pour la suite de tests), GNOME Doc Utils et Which-2.21 (requis pour la suite de tests et la documentation de gtk-doc)

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

Installation de GTK-Doc

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

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

Pour tester les résultats lancez : make check. Sur certains systèmes, les tests peuvent soit freezer indéfiniment soit échouer.

Maintenant, en tant qu'utilisateur root : 

make install

Contenu

Programmes installés: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan et gtkdoc-scangobj
Bibliothèques installées: Aucune
Répertoires installés: /usr/lib/cmake/GtkDoc, /usr/share/gtk-doc et /usr/share/help/*/gtk-doc-manual

Descriptions courtes

gtkdoc*

ce sont tous des scripts shell 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 2019-02-15 21:01:29 +0000