2018-12-20 OpenSceneGraph3.4.0帮助文档生成记录

昨天闲来无事,想自己创建一个OSG的帮助文档,于是乎,打开电脑,打开Google,开始搜索相关的教程,尝试了若干次,就是成功不得,怎奈山重水复疑无路,一枝红杏出墙来,成功就是一瞬间的事。


说正题,想要生成帮助文档,我们需要准备以下三个工作:   

1. Doxygen Doxygen: Downloads

2. Graphviz Download

3. HTML Help Workshop Download HTML Help Workshop and Documentation from Official Microsoft Download Center

具体这三个是干嘛的,可以Baidu下。


又想吐槽一波^_^ 强大的搜索引擎可以让我们变得无所不知,但是但是but......我们的家当让我们一次又一次的被坑。不得不称赞,Google才是最强大的搜索引擎,没有之一,在科学的道路上,没有平坦的大道,但是Google可以让我们走的更轻松。

给出几个自家产品搜索出来的结果:

1. OpenSceneGraph 3.0.1 生成 chm 文档 - isaaccwoo的博客 - CSDN博客

2. 使用doxygen、graphviz生成OpenSceneGraph文档 - 夏夜_fly - 博客园

3. VS2010+64+OSG3.2.1之一帮助文档的生成 - nuaaqsm0915的专栏 - CSDN博客

如果天时地利人和的话,通过参考上述三种解决方案,可以完成帮助文档的生成,然而,我没有,因为信息零散化,需要花费大量的精力去整合方案,太费劲了,时间都去哪了?


一般使用Google,我会首先输入中文关键字搜索,毕竟我认为中国文字是最瑰丽、最灿烂的文化,一般情况下,问题只能解决一般;这时,我就会用自己的六级英语水平,开始键入英文关键字,奇迹就出现了,我能够被搜索的内容迅速抓住(虽然偶尔还是会用用Google翻译),这就是我想要的,问题迎刃而解。

1. Create Doxygen documentation

2. OpenSceneGraph Forum :: View topic - OpenThreads Doxygen documentation

3. [osg-submissions] Upgrade Doxygen configuration  

4. Merge pull request #42 from podsvirov/topic-upgrade-doxygen-configura… · openscenegraph/OpenSceneGraph@7455db4 · GitHub

在查看了上述的第四个链接的内容后,终于知道问题该怎么解决了,感谢开源软件,感谢好心人!


具体的解决方法如下:

1.首先修改openscenegraph源代码中....\doc\Doxyfiles中的all_Doxyfile、auto_Doxyfile、auto_Mainpage、core_Doxyfile、doxyfile、openthreads.doxyfile(共计6个文件);

2.在上述6个文件中分别添加一行代码(具体在什么位置,您乐意搁那就那,可参考上述标号为4的链接):

EXTENSION_MAPPING      = no_extension=C++

3. 在CMake时,将BUILD组里面的BUILD_DOCUMENTATION打上对勾;

4. Configure一次,出现DOXYGEN组;

5. 将DOXYGEN_EXECUTABLE的Value值设置为doxygen.exe所在的路径,                                  将DOXYGEN_DOT_EXECUTABLE的Value值设置为dot.exe所在的路径;

6. 再次Configure,然后Generate,打开生成的工程,生成doc_openscenegraph和doc_openthreads文件,即可梦想成真。

你可能感兴趣的:(2018-12-20 OpenSceneGraph3.4.0帮助文档生成记录)