Doxygen文檔產生工具

標籤：

　　http://blog.csdn.net/lostaway/article/details/6446786

 

Doxygen 是一個支援 C/C++，以及其它多種語言的跨平台文檔產生工具。如同 JavaDoc, doxygen 直接從源檔案中提取符合 doxygen 注釋規範的注釋，產生文檔[1]。 

1、安裝1.1 安裝 Doxygen 1.7.4(Windows)

地址：ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.4.windows.bin.zip

 

1.2 安裝 graphviz 2.28.0(Windows)

地址：http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.28.0.msi

 

graphviz 是一個由AT&T實驗室啟動的開源工具包，用於繪製DOT語言指令碼描述的圖形[2]。Doxygen 使用 graphviz 自動產生類之間和檔案之間的呼叫歷程圖，如不需要此功能可不安裝該工具包。

 

1.3 安裝 Windows Help Workshop 1.32

地址：http://download.microsoft.com/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe

 

這個工具就不多說了，產生 CHM 協助文檔的。 Doxygen 使用它產生 CHM 格式的文檔。

 

2、配置運行 Doxywizard 開始配置

Doxygen 1.7.4 主介面如 1 所示。

 

說明：

Doxygen 工作目錄(1:) 就是用來存放設定檔的目錄，別無它用。

 

選擇 wizard 標籤下的 Output Topics

相關配置說明如 2 所示。

 

 

選擇 wizard 標籤下的 Diagrams Topics

相關配置說明如 3 所示。

 

如果之前安裝了 Graphviz 工具包，就可啟用該選項。

 

選擇 expert 標籤下的 Project Topics

相關配置說明如 4 所示。

 

說明：編碼格式，UTF-8 是首選。

 

選擇 expert 標籤下的 Input Topics

相關配置說明如 5 所示。

 

 

說明：

輸入的源檔案的編碼，要與源檔案的編碼格式相同。如果源檔案不是UTF-8編碼最好轉一下。

 

 

選擇 expert 標籤下的 HTML Topics

相關配置說明如 6 所示。

 

說明：

如果在 Wizard 的 Output Topics 中選擇了 prepare for compressed HTML (.chm)選項，此處就會要求選擇 hhc.exe 程式的位置。在 windows help workshop 安裝目錄下可以找到 hhc.exe。

 

 

在 Expert 標籤中還有超多的選項，需要按自己的要求去定製。個人喜好問題就不再贅述了，大家可以查 doxygen 文檔啥的，裡面有每個選項的詳細介紹。

 

選擇 Run 標籤

相關配置說明如 7 所示。

 

 點擊 Run doxygen 按鈕， Doxygen 就會從原始碼中抓取符合規範的注釋產生你定製的格式的文檔。接下來的工作就是學習 doxygen 的注釋規範了，參考 《doxygen 快速入門》第 2 節 “常用注釋文法”。慢慢的就可以體會到 doxygen 的方便性。

 

Doxygen 產生 CHM 文檔亂碼的問題

由於 Windows 的預設編碼不是 UTF-8， Doxygen 產生的 CHM檔案目錄和檔案標題列是亂碼。一般解決步驟可以參考《doxygen 快速入門》關於解決目錄亂碼的問題。這裡要補充的一點就是，最好將 index.hhc、index.hhk 、index.hhp都轉為 UTF-8格式。這樣標題列啥的也不會是亂碼了。

參考

[1] http://zh.wikipedia.org/wiki/Doxygen Wikipedia-doxygen

[2] http://zh.wikipedia.org/wiki/Graphviz Wikipedia-graphviz

[3] http://hi.baidu.com/soulmachine/blog/item/6055ad017a9a1606738da58c.html doxygen 快速入門

 

附錄

補充幾張：

 

 

 

（轉）Doxygen文檔產生工具