数据结构
网络
关系型数据库管理系统
操作系统
Java
MS Excel
iOS
HTML
CSS
Android
Python
C 编程
C++
C#
MongoDB
MySQL
Javascript
PHP
物理学
化学
生物学
数学
英语
经济学
心理学
社会学
时尚研究
法律研究生成 MySQL Doxygen 文档内容
MySQL 的源代码包含大量内部文档，这些文档使用 Doxygen 编写。此 Doxygen 内容可在 https://dev.mysqlserver.cn/doc/index-other.html 获取。此 Doxygen 内容可以从 MySQL 源代码分发版本地生成。可以通过遵循以下步骤来实现：
安装 Doxygen
第一步是安装 Doxygen 1.8.11 或更高版本。分发版可在 https://doxygen.cn/ 获取。
安装完成后，需要验证版本号。可以使用以下命令来完成：
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
更新于: 2021年3月8日
165 次查看
广告