VS2010+64+OSG3.2.1之一帮助文档的生成

VS2010+64+OSG3.2.1之一帮助文档的生成

最近在学习OSG3.2.1，发现编译时产生的帮助文档，默认是HTML格式，生成了一大堆网页，使用起来不方面。于是乎进行了研究，折腾了一番，下载了不少库，总结如下：

1、要生成帮助文档，在cmake里要指定DOXYGEN-EXECUTABLE的值

DOXYGEN-EXECUTABLE：Doxygen.exe文件的位置。Doxygen是个开源的生成帮助文档制作软件，可以通过提取代码的注释生成帮助文档。如果不指定合法的Doxygen，则osg编译时无法生成帮助文档。注意要把cmake里面的advanced选中才能显示DOXYGEN-EXECUTABLE选项。

官网：http://www.stack.nl/~dimitri/doxygen/

2、帮助文档要生成照片，还要在cmake里指定DOXYGEN-DOT-EXECUTABLE的值

DOXYGEN-DOT-EXECUTABLE：Graphviz软件中dot.ex文件的位置。如果不指定Graphviz.exe，则生成的帮助文档没有图片。

Graphviz是一个图形可视化软件，Graphviz （英文：GraphVisualizationSoftware的缩写）是一个由AT&T实验室启动的开源工具包，用于绘制DOT语言脚本描述的图形。Doxygen使用Graphviz生成各种图形，例如类的继承关系图、合作图，头文件包含关系图等。可以从Graphviz的网站下载Graphviz的最新版本。dot :一个用来将生成的图形转换成多种输出格式的命令行工具。其输出格式包括PostScript，PDF，SVG，PNG，含注解的文本等等。neato:用于sprintmodel的生成（在MacOS版本中称为energyminimized）。twopi :用于放射状图形的生成。circo ：用于圆形图形的生成。fdp：另一个用于生成无向图的工具。dotty：一个用于可视化与修改图形的图形用户界面程序。lefty ：一个可编程的(使用一种被EZ影响的语言[4])控件，它可以显示DOT图形，并允许用户用鼠标在图上执行操作。Lefty可以作为MVC模型的使用图形的GUI程序中的视图部分。

官网：

http://www.graphviz.org/Download_windows.php

3.要想生成chm格式的帮助文档，还要进行必要的设置

在cmake里配置好以后，点击Generate产生代码。此时如果对代码进行编译，默认产生的帮助文档是网页格式，要想生成其他格式的，打开cmake产生代码doc目录下，找到openscenegraph.doxyfile文件，这个文件是个配置文件，

通过里面的相关选项可以对生成的帮助文档进行设置。打开文件，对红色部分进行设置，即可产生RTF格式和chm格式的帮助文档。

#---------------------------------------------------------------------------

#configuration options related to the RTF output

#---------------------------------------------------------------------------

GENERATE_RTF = NO //是否产生RTF格式的帮助文档

RTF_OUTPUT = rtf

COMPACT_RTF = NO

RTF_HYPERLINKS = NO

RTF_STYLESHEET_FILE =

RTF_EXTENSIONS_FILE =

#---------------------------------------------------------------------------

#configuration options related to the HTML output

#---------------------------------------------------------------------------

GENERATE_HTML = YES

HTML_OUTPUT = OpenSceneGraphReferenceDocs

HTML_FILE_EXTENSION = .html

HTML_HEADER =

HTML_FOOTER ="D:/soft/GIS/osg/OpenSceneGraph-3.2.1-rc3/doc/Doxyfiles/custom_Footer.html"

HTML_STYLESHEET =

HTML_DYNAMIC_SECTIONS = NO

GENERATE_DOCSET = NO

DOCSET_FEEDNAME = "Doxygen generated docs"

DOCSET_BUNDLE_ID = org.doxygen.Project

GENERATE_HTMLHELP = YES //是否产生chm格式的帮助文档

CHM_FILE = "../OpenSceneGraphReferenceDocs-3.2.1.chm"

HHC_LOCATION = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"

GENERATE_CHI = NO

CHM_INDEX_ENCODING =

BINARY_TOC = NO

TOC_EXPAND = NO

GENERATE_QHP = NO

设置完成后，编译即可产生帮助文档，该文档在doc目录下。

附带chm格式的帮助文档：

http://download.csdn.net/detail/nuaaqsm0915/7560023