MySQL :: MySQL 8.0 Reference Manual :: 2.9.7 Generating MySQL Doxygen Documentation Content

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

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
```
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.
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)
```
Set the PLANTUML_JAR_PATH environment to the location where you installed PlantUML. For example:
```
export PLANTUML_JAR_PATH=path-to-plantuml.jar
```
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.

PREV HOME UP NEXT