Documentation Home
MySQL 8.4 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 39.8Mb
PDF (A4) - 39.9Mb
Man Pages (TGZ) - 257.9Kb
Man Pages (Zip) - 364.9Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


MySQL 8.4 Reference Manual  /  ...  /  Generating MySQL Doxygen Documentation Content

2.8.10 生成 MySQL Doxygen 文档内容

MySQL 源代码中包含使用 Doxygen 编写的内部文档。生成的 Doxygen 内容可在https://dev.mysql.com/doc/index-other.html中找到。也可以从 MySQL 源代码分发中本地生成该内容,使用以下步骤:

  1. 安装 doxygen 1.9.2 或更高版本。可从http://www.doxygen.nl/下载。

    安装 doxygen 后,验证版本号:

    $> doxygen --version
    1.9.2
  2. 安装PlantUML

    在 Windows (测试于 Windows 10) 安装 PlantUML 时,您必须至少运行一次管理员身份,以便创建注册表键。打开管理员控制台,运行以下命令:

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

    命令应打开 GUI 窗口,并在控制台上返回无错误信息。

  3. PLANTUML_JAR_PATH 环境变量设置为 PlantUML 安装位置的路径。例如:

    $> export PLANTUML_JAR_PATH=path-to-plantuml.jar
  4. 安装Graphviz dot 命令。

    安装 Graphviz 后,验证 dot 可用性。例如:

    $> which dot
    /usr/bin/dot
    
    $> dot -V
    dot - graphviz version 2.40.1 (20161225.0304)
  5. 更改到 MySQL 源代码分发的顶级目录,然后执行以下操作:

    首先,执行 cmake

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

    然后,生成 doxygen 文档:

    $> make doxygen

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

    $> firefox doxygen/html/index.html