生成 MySQL Doxygen 文档内容

mysqlmysqli database

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。在 Windows 10 上安装后，应至少以管理员身份运行一次，以便创建注册表项。

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

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

上述命令将打开一个 GUI 窗口，控制台上没有任何错误。

完成此操作后，必须将 PLANTUML_JAR_PATH 环境变量设置为 PlantUML 的安装位置。让我们看一个例子 −

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

下一步是安装 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 文档。这可以通过执行以下命令来完成 −

shell> make doxygen

完成后，必须检查错误日志。这可以在 top−evel 目录中的 doxyerror 文件中找到。构建正确执行后，可以在浏览器上查看生成的输出。这可以使用以下命令完成 −

shell> firefox doxygen/html/index.html