Installation

Table des matières

Allez d'abord sur la page de téléchargement pour obtenir la dernière distribution, si vous n'avez pas encore téléchargé Doxygen.

Compilation à partir des sources sous UNIX

Si vous avez téléchargé la distribution source, vous avez besoin au moins des éléments suivants pour construire l'exécutable :

  • Les outils GNU flex, bison, libiconv et GNU make
  • Vous avez besoin de python (version 2.7 ou supérieure, voir https://www.python.org.
  • Afin de générer un Makefile pour votre plateforme, vous avez besoin de cmake version 3.14 ou supérieure.

Pour profiter pleinement des fonctionnalités de Doxygen, les outils supplémentaires suivants doivent être installés.

  • La boîte à outils d'interface graphique de Qt version 5.14 ou supérieure (y compris Qt 6). Ceci est nécessaire pour construire l'interface graphique Doxywizard.
  • Une distribution LaTeX : par exemple TeX Live. Ceci est nécessaire pour générer des sorties LaTeX, Postscript et PDF.
  • La version 2.38 ou supérieure de la boîte à outils de visualisation de graphiques nécessaire pour les graphiques de dépendance inclus, les graphiques d'héritage graphique et les graphiques de collaboration. Si vous compilez graphviz vous-même, assurez-vous d'inclure la prise en charge de freetype (qui nécessite la bibliothèque freetype et les fichiers d'en-tête), sinon les graphiques ne rendront pas les étiquettes de texte appropriées.
  • Pour les formules dans la sortie HTML (lorsque MathJax n'est pas utilisé) ou si vous ne souhaitez pas utiliser pdflatex, l'interpréteur ghostscript est nécessaire. Vous pouvez le trouver sur www.ghostscript.com.

Pour les tests, ces dépendances supplémentaires doivent au moins être disponibles :

  • xmllint (libxml2-ultils)
  • bibtex (texlive-binaries)

La compilation se fait maintenant en suivant les étapes suivantes :

1 . Décompressez l'archive, à moins que vous ne l'ayez déjà fait :

gunzip doxygen-$VERSION.src.tar.gz    # uncompress the archive
tar xf doxygen-$VERSION.src.tar       # unpack it

2 . Créez un répertoire de build (par exemple dans l'arborescence source)

cd doxygen-$VERSION
mkdir build
cd build

3 . Exécutez cmake avec le générateur de makefile

cmake -G "Unix Makefiles" ..

cmake essaie de déterminer la plateforme que vous utilisez et recherchera les outils requis. Il signalera si quelque chose manque.

Si vous avez installé Qt-5.14 ou une version supérieure et que vous souhaitez créer l'interface graphique, vous devez l'activer comme suit :

cmake -Dbuild_wizard=YES ..

Pour un aperçu des autres options de configuration, utilisez

cmake -L ..

4 . Compilez le programme en exécutant make :

make

Le programme devrait se compiler sans problème et les binaires (doxygen et éventuellement doxywizard) devraient être disponibles dans le répertoire bin du répertoire build.

5 . Facultatif : générer le manuel d'utilisation.

cmake -Dbuild_doc=YES ..
make docs

Pour permettre à Doxygen de générer la documentation HTML et PDF.

Le répertoire HTML dans le répertoire de construction contiendra désormais la documentation HTML (pointez simplement un navigateur HTML vers le fichier index.html dans le répertoire HTML).

6 . Optionnel : liaison statique

Si vous souhaitez créer une version de Doxygen liée statiquement qui intègre libclang, vous devez d'abord créer LLVM et clang à partir des sources en utilisant les options suivantes :

cmake -DLIBCLANG_BUILD_STATIC=ON \
      -DBUILD_SHARED_LIBS=OFF \
      -DLLVM_ENABLE_PIC=OFF \
      -DLLVM_BUILD_LLVM_DYLIB=OFF \
      -DLLVM_BUILD_LLVM_C_DYLIB=OFF \
      -DLLVM_ENABLE_TERMINFO=OFF \
      path_to_llvm_root_source_dir

puis créer Doxygen avec ces options :

cmake -DCMAKE_BUILD_TYPE=Release \
      "-DCMAKE_FIND_LIBRARY_SUFFIXES=.a" \
      "-ldl;-lz;-lpthread" \
      -Duse_libclang=YES \
      path_to_doxygen_root_source_dir

Installation des binaires sous UNIX

Après la compilation du code source, effectuez un make install pour installer Doxygen. Si vous avez téléchargé la distribution binaire pour Linux, saisissez :

make install

Les binaires sont installés dans le répertoire /usr/local/bin, les pages de manuel dans /usr/local/man/man1 et la documentation dans /usr/local/doc/doxygen. Pour modifier cela, modifiez simplement le Makefile.

Note

Vous avez besoin de l'outil d'installation GNU pour que cela fonctionne (il fait partie du package coreutils). D'autres outils d'installation peuvent placer les binaires dans le mauvais répertoire !

Si vous avez un package RPM ou DEB, veuillez suivre la procédure d'installation standard requise pour ces packages.

Compilation à partir des sources sous Windows

À partir de la version 1.8.10, les fichiers de build doivent être générés par cmake. cmake peut être téléchargé à partir de https://cmake.org/download/.

Pour le moment, seule la version communautaire de Visual Studio 2019 est testée, mais d'autres versions peuvent également fonctionner.

Alternativement, vous pouvez compiler Doxygen à la manière d'UNIX en utilisant Cygwin ou MinGW.

L'étape suivante consiste à installer les versions modernes de bison et flex (voir https://sourceforge.net/projects/winflexbison/. Après l'installation et leur ajout à votre path, renommez win_flex.exe en flex.exe et win_bison.exe en bison.exe). De plus, vous devez installer python (version 2.7 ou supérieure, voir https://www.python.org). Ces packages sont nécessaires pendant le processus de compilation.

Téléchargez l'archive source de Doxygen et placez-la quelque part (par exemple, utilisez c:\tools).

Démarrez maintenant un shell de commande natif de Visual Studio (pour x86 ou x64) et tapez :

cd c:\tools
tar zxvf doxygen-x.y.z.src.tar.gz

pour décompresser les sources (vous pouvez obtenir tar par exemple à partir de https://gnuwin32.sourceforge.net/packages.html). Vous pouvez également utiliser un programme de décompression, comme 7-Zip (voir https:///www.7-zip.org/ ou utiliser la fonction de décompression intégrée des systèmes Windows modernes).

Votre environnement est maintenant configuré pour générer les fichiers de projet requis pour Doxygen.

Changez le répertoire vers le répertoire doxygen-x.y.z, créez et modifiez un répertoire de build

mkdir build
cd build
cmake -G "Visual Studio 14 2015" ..

Cela créera un fichier de projet qui pourra ensuite être ouvert dans Visual Studio.

Si vous préférez compiler à partir de l'invite de commande, vous pouvez utiliser ce qui suit à la place :

mkdir build
cd build
cmake -G "NMake Makefiles" ..
nmake

Notez que la compilation de Doxywizard nécessite Qt 5.14 ou une version plus récente (voir https://doc.qt.io/).

Lisez également la section suivante pour connaître les outils supplémentaires dont vous pourriez avoir besoin pour exécuter Doxygen avec certaines fonctionnalités activées.

Installation des binaires sous Windows

Doxygen est une archive auto-installable, l'installation est donc extrêmement simple. Il suffit de suivre les boîtes de dialogue.

Après l'installation, il est recommandé de télécharger et d'installer également GraphViz (la version 2.38 ou supérieure est fortement recommandée). Doxygen peut utiliser l'outil dot du package GraphViz pour restituer des diagrammes plus jolis, voir l'option HAVE_DOT dans le fichier de configuration.

Si vous souhaitez produire des fichiers HTML compressés (voir GENERATE_HTMLHELP) dans le fichier de configuration, vous avez besoin de l'atelier d'aide HTML de Microsoft. Début 2021, Microsoft a repris la page d'origine, avec entre autres les liens de téléchargement, hors ligne l'atelier d'aide HTML était déjà en mode maintenance depuis de nombreuses années). Vous pouvez télécharger l'atelier d'aide HTML à partir des archives Web à l'adresse d'installation.

Si vous souhaitez produire des fichiers d'aide compressés Qt (voir QHG_LOCATION) dans le fichier de configuration, vous avez besoin de qhelpgenerator qui fait partie de Qt. Vous pouvez télécharger Qt à partir de Téléchargements de Logiciels Qt.

Pour générer une sortie PDF ou utiliser des formules scientifiques, vous devrez également installer LaTeX et Ghostscript.

Il existe un certain nombre de distributions pour latex. Les plus populaires qui devraient fonctionner avec Doxygen sont MikTex et proTeXt.

Ghostscript peut être téléchargé depuis Sourceforge.

Après avoir installé latex et Ghostscript, vous devrez vous assurer que les outils latex.exe, pdflatex.exe et gswin32c.exe (ou gswin64c.exe) sont présents dans le chemin de recherche d'une boîte de commande. Suivez ces instructions si vous n'êtes pas sûr et exécutez les commandes à partir d'une boîte de commande pour vérifier que cela fonctionne.