安装 doxygen 1.9.2 或更高版本。发行版可在 http://www.doxygen.nl/ 找到。

安装 doxygen 后，验证版本号

$> doxygen --version
1.9.2

安装 PlantUML.

在 Windows 上安装 PlantUML 时（在 Windows 10 上测试过），必须以管理员身份运行它至少一次，这样它才能创建注册表项。打开一个管理员控制台并运行以下命令

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

该命令应该打开一个 GUI 窗口，并在控制台上不返回任何错误。

将 PLANTUML_JAR_PATH 环境变量设置为安装 PlantUML 的位置。例如

$> export PLANTUML_JAR_PATH=path-to-plantuml.jar

安装 Graphviz dot 命令。

安装 Graphviz 后，验证 dot 的可用性。例如

$> which dot
/usr/bin/dot

$> dot -V
dot - graphviz version 2.40.1 (20161225.0304)

将位置更改为 MySQL 源代码发行版的最顶层目录，然后执行以下操作

首先，执行 cmake

$> cd mysql-source-directory
$> mkdir build
$> cd build
$> cmake ..

接下来，生成 doxygen 文档

$> make doxygen

检查错误日志，该日志位于最顶层目录下的 doxyerror.log 文件中。假设构建已成功执行，请使用浏览器查看生成的输出。例如

$> firefox doxygen/html/index.html