使用doxygen、graphviz生成OpenSceneGraph文档

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

时间: 2024-10-13 08:00:32

使用doxygen、graphviz生成OpenSceneGraph文档的相关文章

安装doxygen(一个自动文档生成工具)

由于你电脑里可能还没有doxygen,我们先来安装一下: sudo apt-get install doxygen doxygen-gui [sudo] password for wj: Reading package lists... Done Building dependency tree Reading state information... Done The following package was automatically installed and is no longer

PHP的学习--使用PhpDocumentor 2生成API文档

官网地址:http://www.phpdoc.org/ 项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序. 基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性. phpDocumentor 2的特点: 兼容php5.3,全面支持命名空间和闭包等. 识别支持任何tag,以及一些追加的 (比如 @link

iOS开发日记23-Xcode生成API文档(HeaderDoc)

今天博主有一个Xcode生成API文档的需求,遇到了一些困难点,在此和大家分享,希望能够共同进步. 今天公司和客户交接源码,但是客户提出不仅需要源码,还需要相应的技术文档,今天博主就和大家分享一下,如何使用Xcode生成你的技术文档. 生成技术文档主要有三个工具: headerdoc, doxygen 和 appledoc.其中headerdoc是苹果官方的生成工具,后两个是第三方工具.如果Xcode版本更新,则需要重新配置第三方工具,个人感觉虽然功能强大,但是配置繁琐,推荐大家使用header

【Unity3D】【NGUI】本地生成API文档

原地址:http://blog.csdn.net/u012091672/article/details/17438135 NGUI讨论群:333417608 1.安装Doxygen(http://www.stack.nl/~dimitri/doxygen/) 2.配置 1)工程名 2)版本 3)源代码目录(根据自己的修改) 4)递归扫描(包含子目录) 5)输出目录 1)只输出可以被文档化的实体 2)c#文档优化 1)有导航栏 2)不使用排版 1)随便指定个目录(用来保存配额) 2)切换到运行界面

使用Xcode生成API文档---01简介

生成技术文档主要有三个工具: 1.headerdoc, 优点:xcode 自带的文档生成工具.基于命令行的操作.使用方便. 缺点:但是只能生成以 /*! */ 的格式的注释.还有一个缺点是每个类文件对应一个注释文件,没有最后汇总导航的index文件. 2.doxygen, 优点:功能强大.三者中支持语言最多的.无headerdoc缺点.基于图形化的操作界面, 缺点:配置较多,可以生成html文档或pdf文档. 3.appledoc. 优点:基于命令行的操作.使用方便.无headerdoc缺点.默

用Aspose.Words for .NET动态生成word文档中的数据表格

1.概述 最近项目中有一个这样的需求:导出word 文档,要求这个文档的格式不是固定的,用户可以随便的调整,导出内容中的数据表格列是动态的,例如要求导出姓名和性别,你就要导出这两列的数据,而且这个文档不是导出来之后再调整而是导出来后已经是调整过了的.看到这里,您也许马上想到用模板导出!而且.NET中自带有这个组件:Microsoft.Office.Interop.Word,暂且可以满足需求吧.但这个组件也是有局限性的,例如客户端必须装 office组件,而且编码复杂度高.最麻烦的需求是后面那个-

读thinking in java的收获(二) --eclipse生成javadoc文档

最开始学习java语言的时候学过生成javadoc不过当时只是用windows命令行生成.读了这里的javadoc温故而知新发现其实我们做的项目就用到了一些注释,只是没有用eclipse 生成这份文档,通过查阅,最终补全了这份知识. 一.书中的代码: <pre name="code" class="java">//:object/HelloDate.java package unit2; import java.util.Date; /** * The

vs2010代码注释自动生成api文档

最近做了一些接口,提供其他人调用,要写个api文档,可是我想代码注释已经写了说明,能不能直接把代码注释生成api?于是找到以下方法 环境:vs2010 先下载安装Sandcastle 和Sandcastle Help File Builder 下载地址 http://sandcastle.codeplex.com/ http://shfb.codeplex.com/ 其中Sandcastle Help File Builder安装较复杂,安装红框内的即可 安装完成后,然后让要使用的项目输出xml

SpringBoot+rest接口+swagger2生成API文档+validator+mybatis+aop+国际化

代码地址:JillWen_SpringBootDemo mybatis 1. 添加依赖: <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>${mybatis.version}</version> </dependency> &