OpenSceneGraph是一款开源的c++三维引擎库,不过因为是开源,所以相关文档十分稀缺。虽然官网提供的源码可以直接生成doxygen文档,不过貌似不太好用,反正我是没有正确生成。
自己研究了一下用doxygen、graphviz生成OpenSceneGraph文档,并且最终成功生成相关文档,把过程整理一下,希望对大家有所帮助。
原料:
doxygen-1.8.11-setup、graphviz-2.38,
这两款软件都是开源的,下载地址分别是:
http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.12-setup.exe
http://graphviz.org/pub/graphviz/stable/windows/graphviz-2.38.msi
两款软件的安装都比较简单,不作赘述。
步骤:
1.找到OpenSceneGraph源码路径下的\doc\Doxyfiles,这个目录下存放着各种生成文档的相关配置,我用的是”all_Doxyfile“,这个文件中好多变量需要我们手动修改一下。
主要包括:${OPENSCENEGRAPH_VERSION}、${OpenSceneGraph_SOURCE_DIR}、${DOXYGEN_DOT_PATH}
第一个是osg版本号(如3.5.1,根据实际情况填写即可)
第二个osg源码路径
第三个是graphviz的安装路径,该路径不可以包含中文、空格等特殊字符,否则在生成过程中,会报错,具体错误信息如下:
error: problems opening map file xxxx.map for inclusion in the docs!
还有一个需要修改的地方是”DOT_GRAPH_MAX_NODES“,该值默认是50,在文档生成过程中会提示你有些图生成错误,我修改成500,完美生成,无报错。
2.打开doxygen软件,File-Open-\doc\Doxyfiles\all_Doxyfile;
3.直接点击run,生成文档就可以了。