首页doxygen › 使用Doxygen生成libevent document(2.0.15)–CHM格式

使用Doxygen生成libevent document(2.0.15)–CHM格式

libevent自己是不提供在线下载的文档的,用户可以自己去http://libevent.org/在线查看,如最新的文档是2.0.15:http://www.wangafu.net/~nickm/libevent-2.0/doxygen/html/
但是,在线文档毕竟没有离线的看起来舒服和方便,下面我教大家如何制作自己的离线document,以后的每个版本就可以自己制作省的去问google和baidu了:

一、工具准备
1. 首先下载下你要制作的那个版本对应的lievent源代码,现在最新的是2.0.15,ok,那我们就做个这个版本的文档吧,去下载:
https://github.com/downloads/libevent/libevent/libevent-2.0.15-stable.tar.gz
2. 制作libevent文档我们需要doxygen工具和Windows Help Workshop 1.32,对应下载地址:
doxygen 1.7.5.1:
http://heze.onlinedown.net:82/down/doxygen-1.7.5.1-setup.zip
Windows Help Workshop 1.32:
http://download.microsoft.com/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe
二、制作
安装好doxygen和Windows Help Workshop后,我们就可以开始了:
1. 设置project
12773189_1321586349ba4K
1>. Doxygen 工作目录,存放配置文件的目录—我就放在我的安装目录了
2>. 设置工程名字—我们要做的是libevent-2.0.15,所以就设置为了libevent-2.0.15
3>. 我们的代码存放位置—我把libevent-2.0.15放在了D:/workspace/libevent-2.0.15-stable
4>. 是否要递归扫描子目录—勾上
5>. 生成的文档存放路径—设置为d:/libevent_doc
2. 设置Mode:
12773189_1321586361C54F
1>. libevent是C写的,所以我们选择C++ output
3. 设置output
12773189_13215863630xX0
1>. 是否生成CHM文档—勾上
2>. 是否生成PDF文档—去掉
4. 设置Diagrams:
12773189_1321586366FZoL
1>. 使用内置的diagram生成器
2>. 使用GraphViz工具来生成diagram— 如果你要生成专业点的diagram就勾上,并且安装GraphViz
5. 设置Input的文件类型:
12773189_1321586368R76a
1>. 设置要扫描的文件类型,C/C++的就可以了,可以把.JAVA或.py去掉
6. 设置设置CHM相关属性:
12773189_13215863716A28
1>. 设置生成的CHM文件名字
2>. 设置CHM工具的路径—我的是:D:/Program Files (x86)/HTML Help Workshop/hhc.exe
7. OK,可以build的了:
12773189_1321586374eEj2
1>. 点击 run doxygen
8. CHM文档生成了:D:\libevent_doc\html\lbevent-2.0.15.chm
12773189_1321586377h0HM
是不是跟网站上的在线文档一样?;-)

发表评论