Au-delà de Linux® From Scratch (édition System V) - Version 12.1

Chapitre 13. Programmation

Doxygen-1.10.0

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 ou de manuel de référence hors ligne à partir d'un ensemble de fichiers sources documentés. Il y a aussi un support pour générer une sortie RTF, PostScript, des PDF avec hyperliens, du HTML compressé, et des pages de manuel 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 vous y retrouver rapidement dans les sources de grosses distributions. Utilisé avec Graphviz, vous pouvez aussi visualiser les relations entre les divers éléments à l'aide de graphes de dépendance d'inclusion, diagrammes d'héritage, et des diagrammes de collaborations tous générés automatiquement.

This package is known to build and work properly using an LFS 12.1 platform.

Informations sur le paquet

  • Téléchargement (HTTP) : https://doxygen.nl/files/doxygen-1.10.0.src.tar.gz

  • Téléchargement (FTP) :

  • Somme de contrôle MD5 : c7455e9961c3491479929935c5087bf6

  • Taille du téléchargement : 8,0 Mo

  • Estimation de l'espace disque requis : 253 Mo (avec les tests)

  • Estimation du temps de construction : 2,1 SBU (avec parallélisme = 4 ; avec les tests)

Dépendances de Doxygen

Requises

CMake-3.28.3 et git-2.44.0

Facultatives

sGraphviz-10.0.1, ghostscript-10.02.1, libxml2-2.12.5 (requis pour les test), LLVM-17.0.6 (avec clang), (Qt-5.15.12 or qt-alternate-5.15.12) (pour doxywizard), texlive-20230313 (ou install-tl-unx), xapian-1.4.24 (pour doxyindexer) et javacc

Installation de Doxygen

[Note]

Note

Lorsque vous déballez ce paquet, vous verrez peut-être des messages comme « Ignoring unknown extended header keyword 'LIBARCHIVE.xattr.com.apple.TextEncoding' ». Ces messages sont sans danger et vous pouvez les ignorer.

Tout d'abord, corrigez certains scripts python : 

grep -rl '^#!.*python$' | xargs sed -i '1s/python/&3/'

Installez Doxygen en exécutant les commandes suivantes : 

mkdir -v build &&
cd       build &&

cmake -G "Unix Makefiles"         \
      -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -Wno-dev .. &&

make

Pour tester les résultats lancez : make tests.

Si vous préférez générer la documentation du paquet, vous devez avoir Python, TeX Live (pour la doc HTML) et Ghostscript (pour la doc PDS) installés, puis entrer les commandes suivantes: 

cmake -DDOC_INSTALL_DIR=share/doc/doxygen-1.10.0 -Dbuild_doc=ON .. &&

make docs

Maintenant, en tant qu'utilisateur root : 

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

Si vous avez généré la documentation du paquet, alors les pages de manuel sont installées automatiquement et vous n'avez pas à lancer la dernière commande install ….

Explication des commandes

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

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

-Duse_libclang=ON : Utilisez ce paramètre si llvm est installé avec clang, 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 exigez des formules pour créer de la documentation PDF, vous devez avoir installé texlive-20230313. Si vous demandez des formules pour convertir des fichiers PostScript en bitmap, vous devez avoir installé ghostscript-10.02.1.

Contenu

Programmes installés: doxygen et potentiellement, doxywizard, doxyindexer et doxysearch.cgi
Bibliothèques installées: Aucune
Répertoire installé: /usr/share/doc/doxygen-1.10.0

Descriptions courtes

doxygen

est un outil en 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 à partir d'un ou plusieurs fichiers de données produits par doxygen. Voir par exemple https://javacc.github.io/javacc/

doxysearch.cgi

est un programme CGI pour chercher des données indexées par doxyindexer