MySQL 8.3 Release Notes
MySQL 源代码包含使用 Doxygen 编写的内部文档。生成的 Doxygen 内容可在 https://dev.mysql.com/doc/index-other.html 中找到。也可以从 MySQL 源代码分布中使用以下过程生成该内容:
-
安装 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