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
登錄后復制
以上就是生成 MySQL Doxygen 文檔內容的詳細內容,更多請關注www.92cms.cn其它相關文章!