使用Doxygen来生成Box2d的API文档

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

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

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

先下载doxygen的向导程序doxygenwizard,而后安装,操做以下spa

下载地址能够到上面的csdn博客中查找网址。 .net

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

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

以下图: 教程

可是html格式不是我想要的,我须要的是一个pdf文档和chm文档因此须要进行下面的步骤:文档

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

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


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

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

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

相关文章
相关标签/搜索