生成 MySQL Doxygen 文件內容
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
廣告