Doxygen 常规使用

Doxygen官网地址:http://www.doxygen.org/


使用指南: http://www.stack.nl/~dimitri/doxygen/doxywizard_usage.html
下载地址: http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
Linux i386  -- doxygen-1.5.9.linux.bin.tar.gz
Windows 95/98/ME/NT/2000/XP/Vista -- doxygen-1.5.9-setup.exe

步骤1 :下载doxygen的binary 包 doxygen下载地址:Doxygen官网
为了使doxygen能够将类图、协作图等 加入到文档中,还要下载安装graphviz for win。
graphviz 下载:
Liunx Redhat 版本下载: http://www.graphviz.org/Download_linux_rhel.php
windows 版本 下载: http://www.graphviz.org/Download_windows.php
全部安装后就可以开始使用了。
步骤2:运行doxygen wizard.exe
通过图形界面运行doxygen,在doxygen的bin目录中运行doxywizard.exe,这时按照doxygen根目录下的文档(doxygen_manual-1.5.2.chm)中 Doxywizard usage一节的说明设置即可。主要包括,源码路径、工作路径、输出路径等。
步骤3:点开始,即可生成文档
最后对文档生成过程中遇到的一些问题进行说明:
1.中文问题:中文注释在文档中是乱码。
解决:在expert中的INPUT选项页的INPUT_ENCODEING中填入“GB2312”,这样基于GB的文本编辑器生成的代码就可以正常使用了。
2.图形问题:无法绘制类图协作图等图形。
解决:首先确保安装了graphviz for win, 注意不是wingraphviz,后者是一个graphviz的com封装,但是doxygen并不是基于它开发的,所以装了也没用。然后在expert 的DOT_PATH中填入graphviz的安装路径。接着在wizard的diagram中选择需要生成的图形类别就可以了。
如果出现无法包含.map文件的错误,可以将工作目录设置成html,并将html中所有文件都清除再试。这个问题的原因还不太确定。
3.输出chm的问题:如何输出.chm文件
在expert中的HTML页:选中“GENERATE_HTMLHELP”,然后在CHM_FILE中填上想要的chm文件名。
HHC_LOCATION中输入hhc.exe文件的路径。hhc.exe可以通过安装HTML Help Workshop获得。
HTML Help Workshop 地址:
http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
这样,基本上就能够用doxygen生成漂亮的文档了。代码方面,doxygen支持多种格式的注释风格,根据manual选择自己喜欢的就好。





使用Doxygen生成全中文的chm文档 生成类图 项目一般设置 首先在“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生成全中文的chm文档 生成类图 项目一般设置 首先在“Wizard”标签的Project项进行如下设置: 项目名称:将在最新的文档首页中显示 源码列表:选择要生成文档的源代码或目录 可以有多个文件或目录形成一个 [更多]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值