Au-delà de Linux® From Scratch (édition systemd) - Version 2017-08-22

Chapitre 11. Outils généraux

GTK-Doc-1.26

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.1.

Informations sur le paquet

Dépendances de GTK-Doc

Requises

docbook-xml-4.5, docbook-xsl-1.79.1, itstool-2.0.2, libxslt-1.1.29 et Python-2.7.13

Facultatives

dblatex ou fop-2.2 (support de XML PDF), Highlight-3.39, GLib-2.52.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) et six (pour certains tests)

Requises (exécution)

six-1.10.0

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.

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 2017-08-21 22:22:19 +0200