Rechercher dans le manuel MySQL

2.9.7 Generating MySQL Doxygen Documentation Content

The MySQL source code contains internal documentation written using Doxygen. The generated Doxygen content is available at https://dev.mysql.com/doc/dev/mysql-server/latest/. It is also possible to generate this content locally from a MySQL source distribution using the following procedure:

  1. Install doxygen 1.8.11 or higher. Distributions are available here:

    http://www.stack.nl/~dimitri/doxygen/download.html

    After installing doxygen, verify the version number:

    shell> doxygen --version
    1.8.11
  2. Install PlantUML. Distributions are available here:

    http://plantuml.com/download.html

    When you install PlantUML on Windows (tested on Windows 10), you must run it at least once as administrator so it creates the registry keys. Open an administrator console and run this command:

    java -jar path-to-plantuml.jar

    The command should open a GUI window and return no errors on the console.

  3. Install the Graphviz dot command. Distributions are available here:

    http://www.graphviz.org/

    After installing Graphviz, verify dot availability. For example:

    shell> which dot
    /usr/bin/dot
    shell> dot -V
    dot - graphviz version 2.28.0 (20130928.0220)
  4. Set the PLANTUML_JAR_PATH environment to the location where you installed PlantUML. For example:

    export PLANTUML_JAR_PATH=path-to-plantuml.jar
  5. To invoke doxygen, change location to the top-level directory of your MySQL source distribution and execute these commands:

    mkdir -p generated/doxygen
    doxygen

    Inspect the error log. It is available in the doxyerror.log file in the top-level directory. Assuming that the build executed successfully, view the generated output using a browser. For example:

    firefox generated/doxygen/html/index.html

    You can use a different browser, and even bookmark the page.


Rechercher dans le manuel MySQL

Traduction non disponible

Le manuel MySQL n'est pas encore traduit en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Document créé le 26/06/2006, dernière modification le 26/10/2018
Source du document imprimé : https://www.gaudry.be/mysql-rf-source-installation-doxygen.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :en Manuel MySQL : https://dev.mysql.com/

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut