MySQL的源代碼包含大量?jī)?nèi)部文檔，這些文檔是使用Doxygen編寫的。此 Doxygen 內(nèi)容可從 https://dev.mysql.com/doc/index-other.html 獲取。此 Doxygen 內(nèi)容可以從 MySQl 源分發(fā)本地生成。這可以通過(guò)以下步驟來(lái)完成 –
安裝 Doxygen
第一步是安裝 Doxygen 1.8.11 或更高版本。這些發(fā)行版可從 http://www.doxygen.nl/ 獲取。
安裝后，必須驗(yàn)證版本號(hào)。這可以使用以下命令來(lái)完成 –
shell > doxygen −−version 1.8.13
登錄后復(fù)制
安裝 PlantUML
下一步是安裝 PlantUML。當(dāng)它安裝在Windows 10上時(shí)，應(yīng)該至少以管理員身份運(yùn)行一次，以便可以創(chuàng)建注冊(cè)表項(xiàng)。
可以打開(kāi)管理員控制臺(tái)，并且需要執(zhí)行以下代碼 –
shell> java −jar path−to−plantuml.jar
登錄后復(fù)制
上述命令將打開(kāi)一個(gè)GUI窗口，控制臺(tái)不會(huì)顯示任何錯(cuò)誤。
完成此步驟后，需要將PLANTUML_JAR_PATH環(huán)境變量設(shè)置為PlantUML安裝的位置。讓我們看一個(gè)示例−
shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar
登錄后復(fù)制
安裝Graphviz
下一步是安裝Graphviz dot命令。
安裝完成后，需要驗(yàn)證dot命令的可用性。可以使用以下命令進(jìn)行驗(yàn)證：
shell> which dot /usr/bin/dot shell> dot −V dot − graphviz version 2.28.0 (20130928.0220)
登錄后復(fù)制
必須更改MySQL源代碼分發(fā)的頂級(jí)目錄的位置。可以使用以下命令進(jìn)行更改 −
shell> cd your-mysql-source-directory shell> mkdir bld shell> cd bld shell> cmake ..
登錄后復(fù)制
首先執(zhí)行 cmake。
生成 Doxygen 文檔
下一步是生成 doxygen 文檔。這可以通過(guò)執(zhí)行以下命令來(lái)完成 –
shell> make doxygen
登錄后復(fù)制
一旦完成這個(gè)步驟，就需要檢查錯(cuò)誤日志。錯(cuò)誤日志可以在頂級(jí)目錄中的doxyerror文件中找到。一旦構(gòu)建成功執(zhí)行，生成的輸出可以在瀏覽器上查看。可以使用以下命令來(lái)完成這個(gè)操作 ?
shell> firefox doxygen/html/index.html
登錄后復(fù)制
以上就是生成 MySQL Doxygen 文檔內(nèi)容的詳細(xì)內(nèi)容，更多請(qǐng)關(guān)注www.92cms.cn其它相關(guān)文章！
