生成 MySQL Doxygen 文档内容

MySQL的源代码包含大量内部文档，这些文档是使用Doxygen编写的。此 Doxygen 内容可从 https://dev.mysql.com/doc/index-other.html 获取。此 Doxygen 内容可以从 MySQl 源分发本地生成。这可以通过以下步骤来完成 -

安装 Doxygen

第一步是安装 Doxygen 1.8.11 或更高版本。这些发行版可从 http://www.doxygen.nl/ 获取。

安装后，必须验证版本号。这可以使用以下命令来完成 -

shell > doxygen −−version
1.8.13

安装 PlantUML

下一步是安装 PlantUML。当它安装在Windows 10上时，应该至少以管理员身份运行一次，以便可以创建注册表项。

可以打开管理员控制台，并且需要执行以下代码 -

shell> java −jar path−to−plantuml.jar

上述命令将打开一个GUI窗口，控制台不会显示任何错误。

完成此步骤后，需要将PLANTUML_JAR_PATH环境变量设置为PlantUML安装的位置。让我们看一个示例−

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

安装Graphviz

下一步是安装Graphviz dot命令。

安装完成后，需要验证dot命令的可用性。可以使用以下命令进行验证：

shell> which dot
/usr/bin/dot

shell> dot −V
dot − graphviz version 2.28.0 (20130928.0220)

必须更改MySQL源代码分发的顶级目录的位置。可以使用以下命令进行更改 −

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

首先执行 cmake。

生成 Doxygen 文档

下一步是生成 doxygen 文档。这可以通过执行以下命令来完成 -

shell> make doxygen

一旦完成这个步骤，就需要检查错误日志。错误日志可以在顶级目录中的doxyerror文件中找到。一旦构建成功执行，生成的输出可以在浏览器上查看。可以使用以下命令来完成这个操作 −

shell> firefox doxygen/html/index.html