Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 45.2Mb
PDF (A4) - 45.2Mb
PDF (RPM) - 40.9Mb
HTML Download (TGZ) - 10.6Mb
HTML Download (Zip) - 10.6Mb
HTML Download (RPM) - 9.2Mb
Man Pages (TGZ) - 207.8Kb
Man Pages (Zip) - 309.9Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb
Excerpts from this Manual

MySQL 8.0 Reference Manual  /  ...  /  Generating MySQL Doxygen Documentation Content

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 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:

    After installing doxygen, verify the version number:

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

    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:

    After installing Graphviz, verify dot availability. For example:

    shell> which 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

    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.

User Comments
User comments in this section are, as the name implies, provided by MySQL users. The MySQL documentation team is not responsible for, nor do they endorse, any of the information provided here.
Sign Up Login You must be logged in to post a comment.