2.9.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 上安装 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 dot 命令。

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

   $> 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

原文链接