使用 Doxygen 来生成 Box2d 的 API 文档

对于 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 格式文档。