本節書摘來自異步社群出版社《gdal源碼剖析與開發指南》一書中的第1章,第1.8節,作者:李民錄 更多章節内容可以通路雲栖社群“異步社群”公衆号檢視。
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等格式。注釋文檔是直接從源檔案中提取的,這樣可以保持與源代碼的一緻性。
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所示。