Doxygen-1.8.13
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.
Ce paquet est connu pour se construire correctement sur une
plateforme LFS-8.1.
Informations sur le paquet
Dépendances de Doxygen
Requises
CMake-3.9.1
Facultatives
sGraphviz-2.40.1, ghostscript-9.21,
libxml2-2.9.4 (requis pour les test), LLVM-4.0.1 (avec
clang), Python-2.7.13 ou Python-3.6.2, Qt-5.9.1 (pour
doxywizard), texlive-20170524 (ou install-tl-unx) et xapian-1.4.4 (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 \
-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.8.13 -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 avez besoin d'utiliser les
fonctions de traduction de langue, vous devez avoir installé
Python-2.7.13. Si vous exigez des formules pour
créer de la documentation PDF, vous devez avoir installé texlive-20170524. Si vous demandez
des formules pour convertir des fichiers PostScript en bitmap, vous
devez avoir installé ghostscript-9.21.
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.8.13
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
http://www.stack.nl/~dimitri/doxygen/manual/extsearch.html.
|
|
doxysearch.cgi
|
est un programme CGI pour chercher des données indexées
par doxyindexer.
|
Last updated on 2017-08-25 03:56:23 +0200