Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.3Mb
PDF (A4) - 40.4Mb
PDF (RPM) - 39.9Mb
HTML Download (TGZ) - 10.6Mb
HTML Download (Zip) - 10.6Mb
HTML Download (RPM) - 9.2Mb
Man Pages (TGZ) - 241.2Kb
Man Pages (Zip) - 346.4Kb
Info (Gzip) - 3.9Mb
Info (Zip) - 3.9Mb
Excerpts from this Manual

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

2.9.10 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/index-other.html. 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 at http://www.doxygen.nl/.

    After installing doxygen, verify the version number:

    shell> doxygen --version
    1.8.13
  2. Install PlantUML.

    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:

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

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

  3. Set the PLANTUML_JAR_PATH environment to the location where you installed PlantUML. For example:

    shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar
  4. Install the Graphviz dot command.

    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)
  5. Change location to the top-level directory of your MySQL source distribution and do the following:

    First, execute cmake:

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

    Next, generate the doxygen documentation:

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

    shell> firefox doxygen/html/index.html