使用Doxygen来生成Box2d的API文档

原创
2015/11/21 23:17
阅读数 205

    对于Doxygen以前只听别人说过,而现在使用它也是一个偶然,缘分吧。前两天看box2d的官方sdk中,发现他有用户手册却没有说明,只是留下了一个Doxygen的文件。事情告一段落,然后今天在看box2d的例子的时候发现他的函数里都有注释即对函数的使用说明,这才让我想起了Doxygen,有了它,可以轻松生成自己最喜欢的chm格式的API文档。而且网上的api文档不好找。

csdn的教程链接http://blog.csdn.net/flyoxs/article/details/7558175

这是给大家参考的至于今天我就给大家一个例子,用doxygen生成Box2d的api文档。

先下载doxygen的向导程序doxygenwizard,然后安装,操作如下

下载地址可以到上面的csdn博客中查找网址。

file->open->box2d(你的box2d目录)/documention->选择doxygen的文件打开,随便点几个选项想发现人家已经帮你配置好了,这里我们直接生成。

run->run doxygen。等一会就会生成一堆html。这里认为html已经满足需要的就不用往下面看了。

如下图:

但是html格式不是我想要的,我需要的是一个pdf文档和chm文档所以需要进行下面的步骤:

点击wizard->output->prepared compress html(chm)

选中后在进行下面的设置:


CHMFILE为你要生成程序的目录。hhclocation即在微软网上下载的

html help workshop,在其安装目录找到hhc.exe生成即可。

最后一步可有可无:点击 expert->output lauguage->chinse,他会把api中的一些文字改为中文的,不过用处不是很大。到此手里会有一份关于box2d的chm格式文档。


展开阅读全文
打赏
1
4 收藏
分享
加载中
更多评论
打赏
0 评论
4 收藏
1
分享
返回顶部
顶部