Au-delà de Linux® From Scratch - Version 7.8;

Chapitre 13. Programmation

Doxygen-1.8.10

Introduction à Doxygen

Le paquet Doxygen contient un système de documentation pour C++, C, Java, C objet, Corba IDL et certaines extensions PHP, C# et D. C'est utile pour la génération de documentation HTML et/ou un manuel de référence hors ligne à partir d'un ensemble de fichiers sources documentés. Il y a aussi un support pokr générer une sortie RTF, PostScript, des PDF avec hyperliens, du HTML compressé, et et pages de man Unix. La documentation est extraite directement des sources ce qui rend beaucoup plus facile la conservation de la cohérence de la documentation avec le code source.

Vous pouvez aussi configurer Doxygen pour extraire la structure du code des fichiers sources non documentés. C'est très utile pour pous y retrouver rapidement dans le source de grosses distributions. Utilisé avec Graphviz, vous pouvez aussi visualiser les relations entre les divers éléments par les sens des graphes de dépendance incluses, l'héritage des diagrammes, et des diagrammes de collaborations tous générés automatiquement.

Ce paquet est connu pour se construire correctement sur une plateforme LFS-7.8.

Informations sur le paquet

Dépendances de Doxygen

Requises

cmake-3.3.1

Facultatives

Graphviz-2.38.0, GPL-Ghostscript-9.16, libxml2-2.9.2, llvm-3.7.0 (avec clang), Python-2.7.10 ou Python-3.4.3, Qt-4.8.7 (pour doxywizard), texlive-20150521 (ou install-tl-unx), et xapian-1.2.21 (pour doxyindexer)

Notes utilisateur : http://wiki.linuxfromscratch.org/blfs/wiki/doxygen

Installation de Doxygen

Installez Doxygen en lançant les commandes suivantes : 

mkdir -v build &&
cd       build &&
cmake -G "Unix Makefiles"         \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      .. &&
make

Pour tester les résultats, tapez : make tests.

Si vous souhaitez générer la documentation du paquet, vous devez avoir installé Python, TeX Live (pour les docs HTML) et Ghostscript (pour les docs PDF) , ensuite tapez la comande suivante: 

sed -i 's:man/man1:share/&:' ../doc/CMakeLists.txt &&
cmake -DDOC_INSTALL_DIR=share/doc/doxygen-1.8.10 -Dbuild_doc=ON .. &&
make docs

Maintenant, en tant qu'utilisateur root : 

make install &&
install -vm644 ../doc/*.1 /usr/share/man/man1

Explication des commandes

sed -i ... CMakeLists.txt: Corrige le répertoire ou les pages de man sont installées.

-Dbuild_wizard=ON : Utilisez ce paramètre si Qt4 est installé et si vous souhaitez construire l'interface graphique.

-Dbuild_search=ON: Utilisez ce paramètre si xapian est installé et que vous souhaitiez construire les outils de recherche externes (doxysearch.cgi et doxyindexer)).

-Duse_libclang=ON: tilisez ce paramètre si llvm avec clang sont isntallé, pour ajouter le support pour l'analyse de libclang.

Configuration de Doxygen

Il n'y a pas réellement de configuration nécessaire pour le paquet Doxygen bien que trois paquets supplémentaires sont requis si vous souhaitez utiliser les fonctionnalités étendues. Si vous avez besoin d'utiliser les fonctions de traduction de langue, vous devez avoir installé Python-2.7.10. Si vous exigez des formul5s pour créer de la documentation PDF, vous devez avoir installé texlive-20150521. Si vous demandez des formules pour convertir des fichiers PostScript en bitmap, vous devez avoir installé GPL-Ghostscript-9.16 .

Contenu

Programmes installés: doxygen et facultativement doxywizard
Bibliothèque installée: Aucune
Répertoire installé: /usr/share/doc/doxygen-1.8.10

Descriptions courtes

doxygen

est un outil basé sur la ligne de commande utilisé pour générer des fichiers modèles de configuration puis pour générer de la documentation à partir de ces modèles. Utilisez doxygen --help pour une explication des paramètres de la ligne de commande.

doxywizard

est un front-end graphique pour configurer et lancer doxygen.

doxyindexer

génère un index de recherche appelé doxysearch.db depuis un ou plusieurs fichiers de données produits par doxygen. voir http://www.stack.nl/~dimitri/doxygen/manual/extsearch.html.

doxysearch.cgi

est un programme CGI pour chercher des données indéxées par doxyindexer.

Last updated on : 2013-03-12 01:31:48 +010