使用doxygen、graphviz生成OpenSceneGraph文档

OpenSceneGraph是一款开源的c++三维引擎库,不过由于是开源,因此相关文档十分稀缺。虽然官网提供的源码能够直接生成doxygen文档,不过貌似不太好用,反正我是没有正确生成。c++

本身研究了一下用doxygen、graphviz生成OpenSceneGraph文档,而且最终成功生成相关文档,把过程整理一下,但愿对你们有所帮助。windows

原料:文档

doxygen-1.8.11-setup、graphviz-2.38,源码

这两款软件都是开源的,下载地址分别是:it

http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.12-setup.exeio

http://graphviz.org/pub/graphviz/stable/windows/graphviz-2.38.msitable

两款软件的安装都比较简单,不做赘述。变量

步骤:ftp

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,生成文档就能够了。

相关文章
相关标签/搜索