下載和安裝 Doxygen

到 Doxygen 官網 下載最新的Doxygen安裝程序，然后安裝。這個軟件包包括了一個GUI界面的前端工具，可以幫助我們方便創建Doxygen配置文件和生成目標文檔。

下載和安裝 chm 編譯器

我們使用微軟古老的 HTML Help Workshop 1.3，這個軟件N久沒更新了。

下載地址： 微軟官網

下載后根據提示安裝。

項目一般設置

首先在“Wizard”標簽的Project項進行如下設置：

項目名稱：將在最新的文檔首頁中顯示
源碼列表：選擇要生成文檔的源代碼或目錄，可以有多個文件或目錄形成一個列表。建議使用相對路徑，相對于當前目錄（也即當前配置文件所在的目錄）
遞歸掃描：如果需要對整個源碼目錄下的所有子目錄及文件生成文檔，請勾選本項
輸出目錄：設置最終生成的幫助文檔的存儲路徑，建議使用相對路徑

下一步，
Mode項，根據需要設置文檔生成模式。

下一步，Output項，設置輸出格式，
勾選HTML和“prepare for compressed HTML(.chm)”

然后切換到“Expert”標簽的“HTML”項，設置HTML和CHM相關的選項：

GENERATE_HTMLHELP：確保已經勾選了
CHM_FILE：最終生成的.chm的文件名，如“HkcProjectHelp.chm”。默認為“index.chm”?？梢允褂寐窂?，也可以使用相對路徑，相對于上面設置的輸出目錄的html目錄（建設使用上一級目錄，如“../MyDoc.chm”）
**HHC_LOCATION：**chm 編譯器（hhc.exe）的全路徑。請指到 HTML Help Workshop 的安裝目錄的 hhc.exe 程序
**CHM_INDEX_ENCODING：**chm索引文件編碼，下面會講到，這里填“GBK”

編碼設置
編碼設置很重要，如果設置不當，生成的文檔會出現亂碼。因為 Doxygen 汲及的東西多，有好幾項編碼設置，所以需要認真對待，根據項目的實情情況設置。

所有高級設置（包括編碼設置）都在“Expert”標簽，重要的設置項如下：

Project/DOXYFILE_ENCODING：當前 Doxygen 配置文件本身的字符編碼，默認為UTF-8，一般不需要修改
Project/OUTPUT_LANGUAGE：輸出語言。這里是指Doxygen自己生成的導航、提示、幫助等文本的文字采用的語言。我們希望幫助文檔是全中文的，所以選擇Chinese
Input/INPUT_ENCODING：輸入文件的編碼。這里是指我們的源代碼文件本身的編碼。在Windows平臺一般是系統編碼（GBK），而Linux平臺一般是UTF-8。請用文本編輯器查看源文件的編碼。這里如果設置的不一致，源碼文件的注釋中所有非ASCII字符將在生成的文檔中變成亂碼。
HTMP/CHM_INDEX_ENCODING：這里設置Doxygen生成的CHM索引文件的編碼，以前是不能設置的，默認為UTF-8，而微軟的編譯器不能識別UTF-8編碼的索引文件，所以最終造成左邊目錄導航欄亂碼。我們設置它為GBK，這樣Doxygen將為我們生成GBK編碼的索引文件（.hhc、.hhk、.hhp）

生成CHM文檔

設置好了后，點擊“Run”→“Run doxygen”生成最終的.chm文檔，如果設置正確，打開后是全中文的了。 

使用doxygen生成中文pdf文檔

作者：zyl910

　　眾所周知，能夠利用doxygen生成pdf文檔——但是，如果其中含有中文的話，那就會遇到一大堆問題無法順利輸出。我花了很長時間摸索，最終找到了讓doxygen順利生成中文pdf的辦法。

　　系統環境——
1) Mac OS X Lion 10.7.5 + MacTeX-2012 。
2) Windows XP SP3 + CTeX 2.9.2.164 。

一、原理解釋
　　doxygen本身并不能直接輸出pdf文件，而是生成了latex目錄，其中有一個 makefile 文件。若系統中裝好了pdflatex，可在latex目錄中運行“make”命令來生成pdf文件。
　　怎樣才能裝好pdflatex呢？mac平臺可安裝MacTeX，windows平臺可安裝CTeX。

　　環境裝好之后，當在latex目錄中運行“make”命令來生成pdf文件時會發現——純英文文檔能順利生成pdf；而含有中文時，不能順利生成pdf文件。

　　對于latex排版，doxygen其實已經做了很多準備，比如——源文件是UTF-8編碼，并默認使用了utf8 package。理論上是支持多國語言的。
　　可對于中文來說，還需要加載 CJKutf8 package，并配置好CJK環境。這才能順利的使用中文。

二、解決方案
　　具體步驟——
1) 使用docxygen生成文檔，注意選上 GENERATE_LATEX 、LATEX_OUTPUT、USE_PDFLATEX（最好還選上 PDF_HYPERLINKS）；

2) 用文本編輯器打開docxygen生成的latex目錄中的refman.tex。找到“/begin{document}”這一行，將其修改為——

/usepackage{CJKutf8} /begin{document}/begin{CJK}{UTF8}{gbsn} 

然后再找到“/end{document}”這一行，將其修改為——

/end{CJK} /end{document} 

保存，關閉。

3) 打開終端，使用cd命令進入latex目錄，然后執行“make”命令。執行完畢后后，該目錄中會出現“refman.pdf”——

我在 mac + MacTeX 環境下make時，能完美生成帶書簽的pdf。
　　而在 win + CTeX 環境下make時，其中還會彈出一堆錯誤（輸入r再回車，可忽略后續錯誤），但是最終還是能夠生成中文的pdf，可惜一般不能順利的構造好書簽。