文件首頁
MySQL 8.4 參考手冊
相關文件 下載本手冊
PDF (美式信紙) - 39.9Mb
PDF (A4) - 40.0Mb
手冊頁 (TGZ) - 258.5Kb
手冊頁 (Zip) - 365.5Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


MySQL 8.4 參考手冊  /  ...  /  產生 MySQL Doxygen 文件內容

2.8.10 產生 MySQL Doxygen 文件內容

MySQL 原始碼包含使用 Doxygen 撰寫的內部文件。產生的 Doxygen 內容可在 https://mysqldev.dev.org.tw/doc/index-other.html 取得。也可以使用下列程序從 MySQL 原始碼發行版本在本機產生此內容

  1. 安裝 doxygen 1.9.2 或更新版本。發行版本可在此處取得 https://doxygen.dev.org.tw/

    安裝 doxygen 後,驗證版本號碼

    $> doxygen --version
    1.9.2
  2. 安裝 PlantUML

    當您在 Windows 上安裝 PlantUML (在 Windows 10 上測試) 時,您必須至少以管理員身分執行一次,以便建立登錄機碼。開啟管理員主控台並執行此命令

    $> java -jar path-to-plantuml.jar

    該命令應開啟 GUI 視窗,且主控台上不應傳回任何錯誤。

  3. PLANTUML_JAR_PATH 環境設定為您安裝 PlantUML 的位置。例如

    $> export PLANTUML_JAR_PATH=path-to-plantuml.jar
  4. 安裝 Graphviz dot 命令。

    安裝 Graphviz 後,驗證 dot 的可用性。例如

    $> which dot
    /usr/bin/dot
    
    $> dot -V
    dot - graphviz version 2.40.1 (20161225.0304)
  5. 將位置變更為 MySQL 原始碼發行版本的頂層目錄,並執行下列動作

    首先,執行 cmake

    $> cd mysql-source-directory
    $> mkdir build
    $> cd build
    $> cmake ..

    接下來,產生 doxygen 文件

    $> make doxygen

    檢查錯誤日誌,該日誌可在頂層目錄中的 doxyerror.log 檔案中取得。假設建置成功執行,請使用瀏覽器檢視產生的輸出。例如

    $> firefox doxygen/html/index.html