Doxygen-1.7.5
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 et fonctionner correctement
sur une plateforme LFS-7.0.
Informations sur le paquet
Dépendances de Doxygen
Facultatives
Qt-4.8.0
(for doxywizard), Graphviz-2.26.3, Python-2.7.2, TeX
Live-20110705, GPL Ghostscript-9.04
Notes utilisateur : http://wiki.linuxfromscratch.org/blfs/wiki/doxygen
Installation de Doxygen
![[Note]](../images/note.png)
Note
Si vous avez installé à la fois Qt-3.3.8d et Qt-4.8.0, assurez-vous
d'initialiser la variable d'environnement QTDIR pour pointer vers
le niveau le plus haut du répertoire Qt4 si vous ajoutez l'option --with-doxywizard.
Installez Doxygen en lançant les
commandes suivantes :
./configure --prefix /usr \
--docdir /usr/share/doc/doxygen-1.7.5 &&
make
Ce paquet n'est pas fourni avec une suite de tests.
Maintenant, en tant qu'utilisateur root :
make install
Si vous souhaitez générer et installer la documentation du paquet
(remarquez que les pages de man ont déjà été installées), vous
devez avoir installé Python,
teTeX ou TeX Live (pour les docs HTML) et Ghostscript (pour les docs PDF), puis exécutez
la commande suivante en tant qu'utilisateur root :
make install_docs
Explication des commandes
--with-doxywizard : Utilisez ce
paramètre si Qt4 est installé et
si vous souhaitez construire le front-end graphique.
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.2. Si vous exigez des formul5s pour
créer de la documentation PDF, vous devez avoir installé TeX
Live-20110705. Si vous demandez des formules pour convertir des
fichiers PostScript en bitmap, vous devez avoir installé GPL
Ghostscript-9.04 .
Contenu
Programmes installés:
doxygen, doxytag, et optionally,
doxywizard
Bibliothèques installées:
Aucune
Répertoire installé:
/usr/share/doc/doxygen
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.
|
|
doxytag
|
est utilisé pour générer un fichier tag et/ou un index de
recherche pour un ensemble de fichiers HTML.
|
|
doxywizard
|
est un front-end graphique pour configurer et lancer
doxygen.
|
Last updated on 2011-12-05 23:58:00 +0100