Doxygen是可用於C++、 C、 Java、 Objective-C、 Python、 IDL (Corba 和 Microsoft flavors)以及部分PHP、 C#和 D語言的文檔系統。
它能通過以下三種方式幫助你:
1,它能從一系列源文件中生成在線瀏覽文檔(HTML形式)或離線參考手冊(LATEX形式)。還支持RTF(MS-Word),PostScript,帶超鏈接的PDF,壓縮的HTML和Unix man頁。文檔是直接從源文件中提取出來的,這使得文檔與源代碼很容易保持同步。
2,通過配置doxygen,你可以從未文檔化的源文件中提取出代碼結構。這對於從大的源碼包中快速理清頭緒是非常有用的。它還能自動產生出包含關係圖、繼承圖和協作圖,使你能直觀地看出各種元素間的關係。
3,你甚至可以“濫用“doxygen來創建平常的文檔(就像本文檔)。
doxygen是在Linux和Mac OS X下開發的,但是它被設計成高可移植的。這使得它可運行在其它Unix變種操作系統上。此外,它還能在windows下運行。
本手冊分爲三部分,其中每個部分又分爲幾節。
第一部分是用戶手冊:
- Installation一節討論瞭如何在你的平臺上下載、編譯和安裝doxygen。
- Getting started一節告訴你如何快速地產生你的第一塊文檔。
- Documenting the code 一節示範了代碼被文檔化的多種方法。
- Lists 一節展示瞭如何創建項目列表。
- Grouping一節展示瞭如何將各種東西集合在一起以組成一個項目列表。
- Including formulas一節展示瞭如何在文檔中插入規則。
- Graphs and diagrams描述了doxygen可生成的圖表和圖形。
- Preprocessing一節說明了doxygen是如何處理宏定義的。
- Automatic link generation一節展示瞭如何在文檔中鏈接文件、類和成員。
- Output Formats一節展示瞭如何生成doxygen支持的各種輸出格式。
- Linking to external documentation一節說明了如何使doxygen創建到外部文檔的鏈接。
- Frequently Asked Questions一節給出常見問題的解答。
- Troubleshooting一節告訴你遇到難題時該怎麼做。
- Features一節概述了doxygen能做什麼。
- Doxygen History一節顯示了doxygen開發過程中的變化和不變之處。
- Doxygen usage一節告訴你如何使用doxygen程序。
- Doxytag usage一節告訴你如何使用doxytag程序。
- Doxywizard usage一節告訴你如何使用
doxywizard
程序。 - Installdox usage一節顯示瞭如果你在使用tag文件時如何運用doxygen產生的installdox腳本。
- Configuration一節顯示瞭如何調整doxygen以生成你要的文檔。
- Special Commands一節顯示了可在文檔中使用的特殊命令的概述。
- HTML Commands一節顯示了可在文檔中使用的HTML命令的概述。
- XML Commands一節顯示了可在文檔中使用的XML命令的概述。
- Doxygen's Internals一節給出了doxygen內部構造的一個整體概述。
- Perl Module output format documentation 顯示瞭如何使用PerlMod的輸出。
- Internationalization 一節說明了如何增加對新的輸出語言的支持。
Copyright © 1997-2005 by Dimitri van Heesch。
Doxygen 遵循GNU General Public License。
Doxygen產生的文檔不受此許可證的影響。
用戶例子
Doxygen支持許多輸出格式,HTML是其中最流行的一種。我搜集了一些來自真實工程,使用了doxygen的漂亮的例子。
它們是一系列使用doxygen的工程中的一部分。如果你知道其它使用了doxygen的工程,請告訴我,我會將它加進來。
未來的工作
雖然doxygen已經被很多人成功地使用,但仍有提升的空間。因此,我編輯了一個可能或被請求增強的列表。
感謝
(略)