OSG开发笔记（二）：OSG帮助文档编译

若该文为原创文章，转载请注明原文出处和链接地址
本文章博客地址：https://blog.csdn.net/qq21497936/article/details/94553278
各位读者，知识无穷而人力有穷，要么改需求，要么找专业人士，要么自己研究

红胖子(红模仿)的博文大全：开发技术集合（包含Qt实用技术、树莓派、三维、OpenCV、OpenGL、ffmpeg、OSG、单片机、软硬结合等等）持续更新中...（点击传送门）

OSG开发专栏（点击传送门）

上一篇：《OSG开发笔记（一）：OSG介绍、编译》

下一篇：《OSG开发笔记（三）：OSG使用osgQt嵌入Qt应用程序》

 

前言

       在后面的开发过程中需要编译文档，编译以下chm版本的帮助文件，不需要编译帮助文档的直接跳过。

 

OSG3.4.0帮助文档下载地址

       https://download.csdn.net/download/qq21497936/11264719

 

编译osg帮助文件

步骤一：配置时，勾选BUILD_DOCUMENTATION

       

       然后进行配置，配置完成，后会出现DOXYGEN

步骤二：查看对应问，需要DOXYGEN可执行程序

        

步骤三：下载Doxygen和graphviz软件安装好

        csdn：https://download.csdn.net/download/qq21497936/11264461

步骤四：重新configure然后generate

        

步骤五：下载Microsoft HTML Help Workshop安装好

       官网：http://www.create-chm.com/chm-help-compiler/

       csdn：https://download.csdn.net/download/qq21497936/11264721

步骤六：重新configure然后generate

        

最终如下：

        

步骤七：修改目标文件夹下doc下的openscengraphi.doxyfile文件

        

       

步骤八：将所有的Doxyfile文件，第一行都添加下代码

       这一步很重要，有可能编出来的帮助文件内容为空！！！！

EXTENSION_MAPPING      = no_extension=C++

步骤九：make install编译（编译帮助文件指定模块）

       特别注意，make是不编译doc模块的

mingw32-make.exe doc_opensceneg raph

mingw32-make.exe doc_openthreads

       生成的doc不会随install部署过去，在目标文件夹的doc下，部署时拷贝doc下2个文件夹过去。

        

        

帮助文档下载地址

       Osg3.4.0帮助文件下载地址：

              https://download.csdn.net/download/qq21497936/11264719

入坑

入坑一：无论怎么编都编不出帮助文件

 解决方法：

        后来经过各种尝试，发现必须指定编译帮助的模块，帮助文件有2个模块可以在makefile文件中查看到。

        

        所以，单独make这2个模块即可。

入坑二：编译帮助文件找不到编译器

        

解决方法：

        设置环境变量和给路径加””都不行，最后发现是exe弄错了，将原本得hhc.exe配置得为hhw.exe。

入坑三：install找不到.chm帮助文件

解决方法：

        makfile里面的install只拷贝了生成的doc下2个帮助文件夹过去，文件夹下面时html，而.chm生成在上层目录

入坑四：检查html和.chm中类的内容为空

解决方法：

        将build目标文加下doc内的所有Doxyfile文件，第二行都添加下代码，这一步很重要，有可能编出来的帮助文件内容为空！！！！

EXTENSION_MAPPING      = no_extension=C++

 

参考资料

https://blog.csdn.net/nuaaqsm0915/article/details/34155769

 

上一篇：《OSG开发笔记（一）：OSG介绍、编译》

下一篇：《OSG开发笔记（三）：OSG使用osgQt嵌入Qt应用程序》

 

原博主博客地址：https://blog.csdn.net/qq21497936
原博主博客导航：https://blog.csdn.net/qq21497936/article/details/102478062
本文章博客地址：https://blog.csdn.net/qq21497936/article/details/94553278