编译环境:win11 + vs2013 + 64位 + qt5.6.3 + osg3.6.5 + oe2.10.2 + osgqt当前最新版本
编译工具:cmake-3.24.1
第三方库:3rdParty_VS2013.5_v120_x64_V10_full.7z
Qt:下载5.6.3版本直接安装
本文说明 html \ chm \ qch三种帮助文档的生成。
一、生成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生成的背景是白色;
# 生成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文件。
编译中问题总结:
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