產生 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

以上是產生 MySQL Doxygen 文件內容的詳細內容。更多資訊請關注PHP中文網其他相關文章！