doxygen这个工具摸了有几天了,从上周的最开始接触,搞不懂怎么用,挺烦的,到昨天晚上利用它将OGRE源代码中的注释生成成HTML帮助文档,感觉这东西还真是挺好用的啊。
当然,这里提一句,生成帮助文档里的类关系图,需要用到GraphViz工具,当然不用也可以,不过我觉得挺好的东西,用用吧还是,显得专业。安装完GraphViz后,要重启电脑,因为会将程序路径添加到Path中,改变了环境变量。
准备工作:
1、电脑安装过CMake,Doxygen和GraphViz,且已重启过。
2、有OGRE源码,假设是D:\OGRE\。
切入主题:
如何利用CMake生成OGRE的解决方案,我不详述,只提一点,在CMake里勾选OGRE_INSTALL_DOCS这一项。生成的OGRE解决方案,会包含一个名为doc的项目,这就是生成api文档的项目。运行这个项目,自然就会生成api的html帮助文档了。
上面所说的这些,都是表面上的操作,而实际的工作是这样完成的:
如下图所示:
html.cfg是一个配置文件,可以用doxygen将其打开。在这个文件里,设置了用doxygen将ogre源代码文件中的注释生成html帮助的参数。比如下面这几个图,基本表示出了主要的几个有用参数。
最后这张图,是查看配置后的参数,以及点击Run,生成html。
至于,如何将生成的html再用HTML Help Workshop生成chm。可以查阅网上相关资料。