《GDAL源码剖析与开发指南》一一1.8 GDAL帮助文档生成-CSDN博客

本节书摘来自异步社区出版社《GDAL源码剖析与开发指南》一书中的第1章，第1.8节，作者：李民录更多章节内容可以访问云栖社区“异步社区”公众号查看。

1.8 GDAL帮助文档生成

GDAL源码剖析与开发指南
1.8.1 Doxygen简介
Doxygen是生成C++注释文档的标准工具，也支持其他语言，如C、Objective-C、C#、PHP、Java、Python、IDL (Corba and Microsoft flavors)、Fortran、VHDL、Tcl等。

我们可以通过三种方式来使用Doxygen。

1．从源文件中以HTML形式生成在线文档浏览器，或者以LATEX形式生成非在线的参考手册，也支持RTF (MS-Word)、PostScript、超链接PDF、压缩HTML等格式。注释文档是直接从源文件中提取的，这样可以保持与源代码的一致性。

2．安装Doxygen从源文件中提取代码结构。Doxygen也可以通过依赖图、继承图等将不同元素之间的关系可视化显示出来，这些图都是自动生成的。但是生成这些图需要借助另外一个强大的开源库Graphviz（Graph Visualization Software）。Graphviz是一个由AT&T实验室启动的开源工具包，用于绘制DOT语言脚本描述的图形，官方网站是http://www.graphviz.org/。

3．可以用Doxygen来创建标准文档。

Doxygen是免费软件，其发布遵守GNU General Public License。Doxygen是在Mac OS X和Linux平台开发的，但是具有很高的移植性，在大多数类Unix平台上可以运行，也支持Windows系统。

1.8.2 生成GDAL开发帮助文档
首先我们下载安装Doxygen和Graphviz，安装完之后最好将Doxygen和Graphviz的bin目录添加到系统环境变量Path中去，否则需要设置一些参数，比较麻烦。

安装完Doxygen后，在开始菜单中有个doxywizard.exe的程序，我们打开程序然后在“File->Open…”菜单中选择GDAL源代码目录下的Doxyfile文件，然后切换到“Run”标签，点击Run Doxygen按钮，如图1-12所示。

接下来系统就会自动提取源代码中的注释生成一份GDAL的帮助文档，默认的输出目录是GDAL目录下的html目录；生成结束后，点击左下角的Show Html Output按钮就可以打开生成的帮助文档。

这样生成的帮助文档和GDAL的官方网站一模一样，但这里生成的只是GDAL的帮助文档，没有OGR的帮助文档。同样按照上述步骤，我们打开GDAL目录下OGR文件夹下的Doxyfile，然后点击“生成”，生成的目录默认为ogr文件夹下的html文件夹。我们将该文件夹重命名为ogr，全部复制到上一层的html中，同时将GDAL目录中的doc文件夹中除dox文件以外的文件全部复制到html文件夹中，然后将编译GDAL后生成的html文件夹的内容与ogr文件夹进行合并，就可以得到一份完整的GDAL帮助文档，首页是html文件夹下的index.html，如图1-13所示。