OSG如何生成帮助文档

一、生成html\chm前期准备：

1. 安装doxygen，下载地址https://doxygen.nl/download.html

2. 安装graphviz，下载地址https://www.graphviz.org/download/

二、生成qch文档前期准备：

安装Qt，仅使用Qt的qhelpgenerator.exe工具

生成流程（默认生成了html）：

1. 在编译OSG源码时勾选BUILD_DOCUMENTATION选项；生成vs的project

2. 在cmake的build目录下修改\doc\openscenegraph.doxfile文件：

    a. 生成 chm 修改如下：需要添加HTML_DYNAMIC_MENUS 和 HMTL_COLORSTYLE两个设置项，HMTL_COLORSTYLE有两个选项DARK\LIGHT，DARK生成的帮助背景是黑色、LIGHT生成的背景是白色；
   1

＃ 生成CHM文档的设置
GENERATE_HTMLHIELP = YES
HTML_DYNAMIC_MENUS = NO
HTML_COLORSTYLE = DARK
CHM_INDEX_ENCODING = GBK
b. 生成 qch 设置如下：

生成 QCH 文件设置

GENERATE_QHP = YES
QCH_FILE = “…/OSG3.6.5.qch”
QHG_LOCATION = “c:/Qt/Qt5.6.3/5.6.3/msvc2013_64/bin/qhelpgenerator.exe”
打开VS2013编译Documentation\doc_openscenegraph工程。

若要编译doc_openthread帮助文档，需要同样的配置，配置\doc\openthreads.doxfile文件。

cmake 后

注意要把cmake里面的advanced选中才能显示 DOXYGEN-EXECUTABLE选项。
生成的chm文档内容为空，解决如下：
将build目标文加下doc内的所有Doxyfile文件，第二行都添加下代码，这一步很重要，有可能编出来的帮助文件内容为空！！！！

EXTENSION_MAPPING = no_extension=C++

编译openscengraph 时间很长，耐心等待。

编译
在这个系列的上一篇文章，我们已经使用 cmake 配置构建了osg3.6.5，并且使用 VS 编译好了 osg3.6.5。再次打开 cmake 勾选 BUILD_DOCUMENTATION 选项。

在这里插入图片描述

然后点击 Configure。 分别勾选 BUILD_REF_DOCS_SEARCHENGINE、BUILD_REF_DOCS_TAGFILE 和 DOCUMENTATION_HTML_HELP选项。再设置 DOXYGEN 和 HTML 内相关选项（我这里安装时候可能是加入了环境变量，这里是自动设置的）。

在这里插入图片描述

编译中问题总结：

1. error: When enabling GENERATE_HTMLHELP the HTML_DYNAMIC_MENUS option should be disabled. I’ll adjust it for you. 修改方法：添加HTML_DYNAMIC_MENUS = NO，参考“编译流程1.a

2. error: When enabling GENERATE_HTMLHELP the HTML_COLORSTYLE‘ option should be eigher ‘LIGHT’ or ‘DARK’ but has value ‘AUTO_LIGHT’. I’ll adjust it for you to ‘LIGHT’. 修改方法：添加HTML_COLORSTYLE = DARK，参考“编译流程1.a

生成结果：