windows下配置doxygen

windows下配置doxygen 收藏
先要安裝doxygen-1.5.2-setup.exe和graphviz-2.12.exe,可以從網站下載:
doxgen的主頁:http://www.stack.nl/~dimitri/doxygen/
graphviz主頁:http://www.graphviz.org/
說明:graphviz支持繪圖

如果要讓doxygen支持輸入chm格式的文檔,還要安裝htmlhelp.EXE, 下載網址:http://go.microsoft.com/fwlink/?LinkId=14188

使用GUI生成配置文件,

http://www.fmddlmyy.cn/text21.html

3.2.1 Project頁
DOXYFILE_ENCODING是Doxyfile的文本編碼。如果文件中有中文字符,可以填寫GBK。

填寫項目名(PROJECT_NAME)、項目版本(PROJECT_NUMBER)、輸出目錄(OUTPUT_DIRECTORY)和輸出語言(OUTPUT_LANGUAGE)。輸出目錄可以按Doxyfile的相對目錄填寫。輸出語言相當於程序資源,選擇Chinese。

Doxywizard的中文支持不完善,中文字符會被存爲亂碼。我們直接編輯Doxyfile,填寫:

PROJECT_NAME = 誰養魚

取消FULL_PATH_NAMES。我們修改了以下參數:

DOXYFILE_ENCODING GBK
PROJECT_NAME 誰養魚
PROJECT_NUMBER 1.0
OUTPUT_DIRECTORY output
OUTPUT_LANGUAGE Chinese
FULL_PATH_NAMES NO


3.2.2 Messages頁
在Messages頁將WARN_LOGFILE填寫爲build.log。這樣,Doxygen會將編譯時出現的警告和錯誤保存在build.log,我們可以對照修改。

WARN_LOGFILE build.log


3.2.3 Input頁
指定輸入源文件目錄(INPUT),將輸入文件編碼(INPUT_ENCODING)改爲GBK。

INPUT ../src
INPUT_ENCODING GBK


FILE_PATTERNS參數是Doxygen要處理的文件類型,缺省值包括Doxygen支持的所有文件類型。不能用Doxygen文檔化任意文件類型。例如Doxygen不支持彙編程序。

3.2.4 Source Browser頁
選擇SOURCE_BROWSER,在文檔中包含源代碼。

SOURCE_BROWSER YES


3.2.5 Html頁
選擇GENERATE_HTMLHELP後,Doxygen會準備生成chm文件需要的項目文件、目錄文件和索引文件。可以通過參數HTML_HEADER和HTML_FOOTER定製頁面,參數值是包含定製內容的文件名。例如,我們可以建立文件html_foot,內容爲:

<p align="right"><A HREF="http://www.fmddlmyy.cn/text20.html" target="_top">窮舉和推理:用C++程序求解“誰養魚”</A></p>
</BODY>
</HTML>

然後將HTML_FOOTER的值設爲html_foot。

GENERATE_HTMLHELP YES
HTML_FOOTER html_foot


3.2.6 LaTex頁
取消GENERATE_LATEX,不產生LaTex輸出。

GENERATE_LATEX NO


3.2.7 Dot頁
在Dot頁,可以選上UML_LOOK、CALL_GRAPH和CALLER_GRAPH。CALL_GRAPH是本函數調用其它函數的示意圖,例如:

 

CALLER_GRAPH是本函數調用者的示意圖,例如:

 

UML_LOOK YES
CALL_GRAPH YES
CALLER_GRAPH YES


3.3 運行Doxygen
對於“誰養魚”這個例子,其它參數都可以使用缺省值。從命令行進入doc目錄後(參見附錄1)運行rebuild.bat,就可以產生refman.chm。這時,我們還沒有對程序作任何文檔化,輸出僅包含Doxygen通過Dot生成的示意圖。

我們可以編輯Doxyfile,將EXTRACT_ALL設爲YES,再rebuild。這時,Doxygen會自動提取程序的所有要素,包括文件、函數、變量、類型定義、枚舉、枚舉值、宏定義等。


配置doxygen:

 先doxygen -g來生成一個Doxygen配置文件,在該配置文件裏設置一些選項,然後doxygen profilename(配置文件名), 就可以生成文檔了。

要生成chm文檔,需要設置如下:
GENERATE_HTMLHELP = NO --> GENERATE_HTMLHELP = YES
BINARY_TOC = NO        --> BINARY_TOC = YES     保留NO
TOC_EXPAND = NO        --> TOC_EXPAND = YES
HHC_LOCATION =         --> HHC_LOCATION = "{path to MS HTML Help Workshop}/hhc.exe"

怎樣設置配置文件裏的選項,可看doxygen安裝下帶的chm說明檔

本文來自CSDN博客,轉載請標明出處:http://blog.csdn.net/AfricaHyena/archive/2007/04/18/1568688.aspx

 

本文來自CSDN博客,轉載請標明出處:http://blog.csdn.net/ldong2007/archive/2009/11/27/4877902.aspx

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章