先要安装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