生成 MySQL Doxygen 文档内容
MySQL的源代码包含很多内部文档,这些文档是使用Doxygen编写的。此Doxygen内容可从 https://dev.mysql.com/doc/index-other.html获得。该Doxygen内容可以从MySQl源分发本地生成。这可以通过以下提到的步骤来完成-
安装Doxygen
第一步是安装Doxygen1.8.11或更高版本。这些发行版可从http://www.doxygen.nl/获得。
安装后,必须验证版本号。这可以使用以下命令来完成-
shell > doxygen −−version 1.8.13
安装PlantUML
下一步是安装PlantUML。当它安装在Windows10上时,它应该至少以管理员身份运行一次,以便可以创建注册表项。
可以打开管理员控制台,需要执行以下代码-
shell> java −jar path−to−plantuml.jar
上面的命令将打开一个GUI窗口,控制台上没有任何错误。
完成此操作后,必须将PLANTUML_JAR_PATH环境变量设置为安装PlantUML的位置。让我们看一个例子-
shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar
安装Graphviz
下一步是安装Graphvizdot命令。
完成此操作后,需要验证点的可用性。这可以使用以下命令来完成-
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