第一部分為使用者手冊
- 「安裝」章節討論如何為您的平台下載、編譯和安裝 Doxygen。
- 「入門」章節告訴您如何快速產生您的第一份文件。
- 「程式碼文件化」章節示範程式碼可以被文件化的各種方式。
- 「Markdown 支援」章節展示 Doxygen 支援的 Markdown 格式。
- 「清單」章節展示如何建立清單。
- 「群組」章節展示如何將事物分組在一起。
- 「包含表格」章節展示如何在文件中插入表格。
- 「包含公式」章節展示如何在文件中插入公式。
- 「圖表與圖形」章節描述 Doxygen 可以產生的圖表與圖形。
- 「預處理」章節解釋 Doxygen 如何處理巨集定義。
- 「自動連結產生」章節展示如何在文件中放入指向檔案、類別和成員的連結。
- 「輸出格式」章節展示如何產生 Doxygen 支援的各種輸出格式。
- 「搜尋」章節展示在 HTML 文件中搜尋的各種方法。
- 「外部索引與搜尋」章節展示如何使用外部搜尋與索引工具。
- 「額外文件」章節解釋如何建立與 API 無關的文件頁面。
- 「自訂輸出」章節解釋如何自訂 Doxygen 產生的輸出。
- 「自訂命令」章節展示如何在您的註解中定義和使用自訂命令。
- 「連結至外部文件」章節解釋如何讓 Doxygen 建立指向外部產生文件的連結。
- 「常見問題」章節提供常見問題的解答。
- 「疑難排解」章節告訴您遇到問題時該怎麼做。
第二部分為參考手冊
第三部分提供給開發人員的資訊
Doxygen 授權條款
版權所有 © 1997-2024 Dimitri van Heesch。
茲授予許可，根據 GNU 通用公共授權條款使用、複製、修改和散布本軟體及其文件。不保證本軟體適用於任何目的。本軟體按「現狀」提供，不附帶任何明示或暗示的擔保。詳情請參閱GNU 通用公共授權。
Doxygen 產生的文件是基於其生產中使用的輸入而衍生的作品；它們不受此授權條款的影響。
使用者範例
Doxygen 支援許多輸出格式，其中 HTML 是最受歡迎的格式。我收集了一些使用 Doxygen 的實際專案的不錯的範例。
這些是使用 Doxygen 的更廣泛的專案清單的一部分。如果您知道其他專案，請通知我，我會將它們加入。
未來工作
雖然 Doxygen 已成功被許多公司和開放原始碼專案使用，但總有進步的空間。
您也可以在錯誤追蹤器中提交增強功能請求。
致謝
感謝
-
DOC++ 的作者 Malte Zöckler 和 Roland Wunderling。Doxygen 的第一個版本借用了一些舊版 DOC++ 的程式碼。雖然從那時起我幾乎重寫了所有的程式碼，但 DOC++ 仍然為我編寫 Doxygen 提供了一個良好的開端。
- Qt Software 的所有人員，感謝他們創建了一個美觀的 GUI 工具包。
- Steffen Schümann，感謝他創建了 Doxygen 使用的 ghc::filesystem。
- Michael McTernan，感謝他創建了現在嵌入在 Doxygen 中的 mscgen。
- 我的兄弟 Frank，感謝他渲染了標誌。
- Harm van der Heijden，感謝他新增了 HTML 說明支援。
- Wouter Slegers，感謝他註冊了 www.doxygen.org 網域名稱。
- Martin Kreis，感謝他新增了 VHDL 支援。
- Parker Waechter，感謝他新增了 RTF 輸出產生器。
- Joerg Baumann，感謝他新增了條件式文件區塊、PDF 連結和組態產生器。
- Tim Mensch，感謝他新增了 todo 命令。
- Christian Hammond，感謝他重新設計了網站。
- Ken Wong，感謝他提供了 HTML 樹狀檢視程式碼。
- Talin，感謝他新增了對帶有 XML 標記的 C# 風格註解的支援。
- Petr Prikryl，感謝他協調了國際化支援。感謝所有語言維護者提供了多種語言的翻譯。
- 還有許多許多人，感謝他們的建議、修補程式和錯誤報告。
贊助連結
(與 doxygen 無關)
Heers
1.13.0 產生