Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 33.8Mb
PDF (A4) - 33.8Mb
PDF (RPM) - 31.8Mb
HTML Download (TGZ) - 8.1Mb
HTML Download (Zip) - 8.2Mb
HTML Download (RPM) - 7.0Mb
Man Pages (TGZ) - 145.9Kb
Man Pages (Zip) - 206.8Kb
Info (Gzip) - 3.1Mb
Info (Zip) - 3.1Mb


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

Pre-General Availability Draft: 2017-11-23

2.8.7 Generating MySQL Doxygen Documentation Content

The MySQL source code contains internal documentation written using Doxygen. The generated Doxygen content is available at http://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.


User Comments
Sign Up Login You must be logged in to post a comment.