### 2.9.10 生成 MySQL Doxygen 文档内容

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

1.  安装**多氧**1.9.2 或更高版本。发行版可在此处获得<http://www.doxygen.nl/>.

    安装后**多氧**，验证版本号：

    ```
    $> doxygen --version
    1.9.2
    ```

2.  安装[植物UML](http://plantuml.com/download.html).

    当您在 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.  安装[图形可视化](http://www.graphviz.org/) **点**命令。

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

    ```
    $> which dot
    /usr/bin/dot

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

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

    首先，执行**制作**：

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

    接下来，生成**多氧**文档：

    ```
    $> make doxygen
    ```

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

    ```
    $> firefox doxygen/html/index.html
    ```
