如果您尚未下載 Doxygen,請先前往下載頁面取得最新的發行版本。
如果您下載的是原始碼發行版,您至少需要以下項目才能建置可執行檔
flex
、bison
、libiconv
和 GNU make
python
(版本 2.7 或更高版本,請參閱 https://www.python.org)。Makefile
,您需要 cmake 版本 3.14 或更高版本。 為了充分利用 Doxygen 的功能,應安裝以下額外工具。
pdflatex
,則需要 ghostscript 解譯器。您可以在 www.ghostscript.com 找到它。現在透過執行以下步驟來完成編譯
解壓縮封存檔,除非您已經這樣做了
gunzip doxygen-$VERSION.src.tar.gz # uncompress the archive tar xf doxygen-$VERSION.src.tar # unpack it
建立一個建置目錄(例如在原始碼樹內)
cd doxygen-$VERSION mkdir build cd build
使用 makefile 產生器執行 cmake
cmake -G "Unix Makefiles" ..
cmake
會嘗試判斷您使用的平台,並尋找所需的工具。如果缺少任何項目,它會回報。
如果您已安裝 Qt-5.14 或更高版本,並且想要建置 GUI 前端,則應按如下方式啟用它
cmake -Dbuild_wizard=YES ..
如需其他配置選項的概述,請使用
cmake -L ..
透過執行 make 來編譯程式
make
程式應無誤地編譯,並且二進位檔(doxygen
和可選的 doxywizard
)應在建置目錄內的 bin 目錄中提供。
可選:產生使用者手冊。
cmake -Dbuild_doc=YES .. make docs
讓 Doxygen 產生 HTML 和 PDF 文件。
建置目錄內的 HTML 目錄現在將包含 HTML 文件(只需將 HTML 瀏覽器指向 HTML 目錄中的檔案 index.html
即可)。
可選:靜態連結
如果您想要建置嵌入 libclang 的 Doxygen 靜態連結版本,您需要先使用以下選項從原始碼建置 LLVM 和 clang
cmake -DLIBCLANG_BUILD_STATIC=ON \ -DBUILD_SHARED_LIBS=OFF \ -DLLVM_ENABLE_PIC=OFF \ -DLLVM_BUILD_LLVM_DYLIB=OFF \ -DLLVM_BUILD_LLVM_C_DYLIB=OFF \ -DLLVM_ENABLE_TERMINFO=OFF \ path_to_llvm_root_source_dir
然後使用這些選項建置 Doxygen
cmake -DCMAKE_BUILD_TYPE=Release \ "-DCMAKE_FIND_LIBRARY_SUFFIXES=.a" \ "-ldl;-lz;-lpthread" \ -Duse_libclang=YES \ path_to_doxygen_root_source_dir
在編譯原始碼後,執行 make install
以安裝 Doxygen。如果您下載了 Linux 的二進位發行版,請輸入
make install
二進位檔會安裝到 /usr/local/bin
目錄中,man 頁面會安裝到 /usr/local/man/man1
中,文件會安裝到 /usr/local/doc/doxygen
中。若要變更此設定,只需編輯 Makefile。
如果您有 RPM 或 DEB 套件,請遵循這些套件所需的標準安裝程序。
從 1.8.10 版開始,建置檔案需要由 cmake 產生。可以從 https://cmake.dev.org.tw/download/ 下載 cmake。
目前僅測試了 Visual Studio 2019 的社群版本,但其他版本也可能有效。
或者,您可以使用 Cygwin 或 MinGW,以UNIX 方式編譯 Doxygen。
下一步是安裝新版本的 bison
和 flex
(請參閱 https://sourceforge.net/projects/winflexbison/)。安裝並將它們新增至您的 path
後,將 win_flex.exe
重新命名為 flex.exe
,並將 win_bison.exe
重新命名為 bison.exe
) 此外,您必須安裝 python
(版本 2.7 或更高版本,請參閱 https://www.python.org)。在編譯過程中需要這些套件。
下載 Doxygen 的原始碼 tarball,並將其放置在某處(例如使用 c:\tools
)
現在啟動 Visual Studio 原生命令殼層(適用於 x86 或 x64),然後輸入
cd c:\tools tar zxvf doxygen-x.y.z.src.tar.gz
以解壓縮原始碼(您可以從例如 https://gnuwin32.sourceforge.net/packages.html 取得 tar
)。或者,您可以使用解壓縮程式,例如 7-Zip(請參閱 https://www.7-zip.org/),或使用現代 Windows 系統的內建解壓縮功能)。
現在您的環境已設定為產生 Doxygen 所需的專案檔案。
將目錄變更為 doxygen-x.y.z
目錄,建立並變更為建置目錄
mkdir build cd build cmake -G "Visual Studio 14 2015" ..
這會建立一個專案檔案,然後可以在 Visual Studio 中開啟。
如果您偏好從命令提示字元進行編譯,則可以改用以下方式
mkdir build cd build cmake -G "NMake Makefiles" .. nmake
請注意,編譯 Doxywizard 需要 Qt 5.14 或更新版本(請參閱 https://doc.qt.io/)。
另請閱讀下一節,了解您可能需要安裝的其他工具,才能啟用某些功能來執行 Doxygen。
Doxygen 以自我安裝封存檔的形式提供,因此安裝非常簡單。只需按照對話方塊操作即可。
安裝後,建議同時下載並安裝 GraphViz(強烈建議使用 2.38 或更高版本)。Doxygen 可以使用 GraphViz 套件的 dot
工具來呈現更精美的圖表,請參閱組態檔案中的 HAVE_DOT 選項。
如果您想要產生壓縮的 HTML 檔案(請參閱組態檔案中的 GENERATE_HTMLHELP),則需要 Microsoft HTML Help Workshop。在 2021 年初,Microsoft 將包含下載連結的原始頁面下線,而 HTML Help Workshop 已經多年處於維護模式)。您可以從網路封存檔下載 HTML Help Workshop,網址為 安裝可執行檔。
如果您想要產生 Qt 壓縮說明檔案(請參閱組態檔案中的 QHG_LOCATION),則需要 qhelpgenerator,它是 Qt 的一部分。您可以從 Qt Software 下載下載 Qt。
為了產生 PDF 輸出或使用科學公式,您還需要安裝 LaTeX 和 Ghostscript。
對於 ,存在許多發行版本。應與 Doxygen 搭配使用的常見版本為 MikTex 和 proTeXt。
可以從 Sourceforge 下載 Ghostscript。
安裝 和 Ghostscript 後,您需要確保 latex.exe、pdflatex.exe 和 gswin32c.exe(或 gswin64c.exe)工具存在於命令方塊的搜尋路徑中。如果您不確定,請按照這些指示執行,並從命令方塊執行命令以驗證其是否有效。