Documentation Home
MySQL 8.0 参考手册
MySQL 8.0 参考手册  / 第 2 章安装和升级 MySQL  / 2.9 从源码安装MySQL  /  2.9.10 生成MySQL Doxygen文档内容

2.9.10 生成MySQL Doxygen文档内容

MySQL 源代码包含使用 Doxygen 编写的内部文档。生成的 Doxygen 内容可在 https://mysql.net.cn/doc/index-other.html获得。也可以使用以下过程从 MySQL 源分发本地生成此内容：

  1. 安装doxygen 1.9.2 或更高版本。分发版位于 http://www.doxygen.nl/。

    安装doxygen后，验证版本号： 

    $> doxygen --version
1.9.2

  2. 安装 PlantUML。

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

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

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

  3. 将PLANTUML_JAR_PATH环境设置为安装 PlantUML 的位置。例如： 

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

  4. 安装 Graphviz 点命令。

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

    $> which dot
/usr/bin/dot

$> dot -V
dot - graphviz version 2.28.0 (20130928.0220)

  5. 将位置更改为 MySQL 源代码分发的顶级目录并执行以下操作：

    首先，执行cmake： 

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

    接下来，生成doxygen文档： 

    $> make doxygen

    检查错误日志。它 doxyerror.log在顶级目录的文件中可用。假设构建成功执行，使用浏览器查看生成的输出。例如： 

    $> firefox doxygen/html/index.html