55 使用Doxygen创建文档
登录

使用Doxygen创建文档

作者: osgChina 发布于2018-10-22 16:51:17 分类 : 用户指南

Doxygen网上的教程大把,就是一个工具,不要想的太神秘,需要使用Doxygen和html workshop来构建OSG的chm格式的文档。--FreeSouth注。

OSG的 ReferenceGuides 是使用Doxygen来构建的,构建本地文档需要两个工具 Doxygen + GraphViz's dot 。

Doxygen 从此处下载:

http://www.doxygen.org

GrpahViz's dot 从此处下载:

http://www.graphviz.org/

如果使用doxygen自动构建,则需要设置OSGHOME环境变量,把其指向OpenSceneGraph源码根目录,然后运行Doxygen,参数为一个配置文件,举例如下:

cd /home/myaccount/[=OpenSceneGraph
export OSGHOME=`pwd`
doxygen doc/Doxyfiles/core_Doxyfile

然后等待Doxygen处理完成在doc/OpenSceneGraphReferenceDocs下可以浏览文档。