Générer le contenu de la documentation MySQL Doxygen

Le code source de MySQL contient une documentation interne complète, écrite à l'aide de Doxygen. Ce contenu Doxygen est disponible sur https://dev.mysql.com/doc/index-other.html. Ce contenu Doxygen peut être généré localement à partir de la distribution source MySQL. Cela peut être fait en suivant les étapes -

Installer Doxygen

La première étape consiste à installer Doxygen 1.8.11 ou supérieur. Ces distributions sont disponibles sur http://www.doxygen.nl/.

Après l'installation, le numéro de version doit être vérifié. Cela peut être fait en utilisant la commande suivante -

shell > doxygen −−version
1.8.13

Installer PlantUML

L'étape suivante consiste à installer PlantUML. Lorsqu'il est installé sur Windows 10, il doit être exécuté en tant qu'administrateur au moins une fois afin que les clés de registre puissent être créées.

La console d'administrateur peut être ouverte et le code suivant doit être exécuté -

shell> java −jar path−to−plantuml.jar

La commande ci-dessus ouvrira une fenêtre GUI et la console n'affichera aucune erreur.

Après avoir terminé cette étape, vous devez définir la variable d'environnement PLANTUML_JAR_PATH sur l'emplacement de l'installation de PlantUML. Voyons un exemple −

shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar

Installation de Graphviz

L'étape suivante consiste à installer la commande Graphviz dot.

Une fois l'installation terminée, vous devez vérifier la disponibilité de la commande dot. Cela peut être vérifié à l'aide de la commande suivante :

shell> which dot
/usr/bin/dot

shell> dot −V
dot − graphviz version 2.28.0 (20130928.0220)

L'emplacement du répertoire de niveau supérieur de la distribution du code source MySQL doit être modifié. Cela peut être modifié à l'aide de la commande suivante −

shell> cd your-mysql-source-directory
shell> mkdir bld
shell> cd bld
shell> cmake ..

Exécutez d'abord cmake.

Générer la documentation Doxygen

L'étape suivante consiste à générer la documentation Doxygen. Cela peut être fait en exécutant la commande suivante -

shell> make doxygen

Une fois cette étape terminée, vous devez vérifier le journal des erreurs. Le journal des erreurs se trouve dans le fichier doxyerror dans le répertoire de niveau supérieur. Une fois la construction exécutée avec succès, la sortie générée peut être visualisée sur le navigateur. Cela peut être fait en utilisant la commande suivante −

shell> firefox doxygen/html/index.html

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!