OpenSceneGraph是一款開源的c++三維引擎庫,不過由於是開源,因此相關文檔十分稀缺。雖然官網提供的源碼能夠直接生成doxygen文檔,不過貌似不太好用,反正我是沒有正確生成。c++
本身研究了一下用doxygen、graphviz生成OpenSceneGraph文檔,而且最終成功生成相關文檔,把過程整理一下,但願對你們有所幫助。windows
原料:文檔
doxygen-1.8.11-setup、graphviz-2.38,源碼
這兩款軟件都是開源的,下載地址分別是:it
http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.12-setup.exeio
http://graphviz.org/pub/graphviz/stable/windows/graphviz-2.38.msitable
兩款軟件的安裝都比較簡單,不做贅述。變量
步驟:ftp
1.找到OpenSceneGraph源碼路徑下的\doc\Doxyfiles,這個目錄下存放着各類生成文檔的相關配置,我用的是」all_Doxyfile「,這個文件中好多變量須要咱們手動修改一下。軟件
主要包括:${OPENSCENEGRAPH_VERSION}、${OpenSceneGraph_SOURCE_DIR}、${DOXYGEN_DOT_PATH}
第一個是osg版本號(如3.5.1,根據實際狀況填寫便可)
第二個osg源碼路徑
第三個是graphviz的安裝路徑,該路徑不能夠包含中文、空格等特殊字符,不然在生成過程當中,會報錯,具體錯誤信息以下:
error: problems opening map file xxxx.map for inclusion in the docs!
還有一個須要修改的地方是」DOT_GRAPH_MAX_NODES「,該值默認是50,在文檔生成過程當中會提示你有些圖生成錯誤,我修改爲500,完美生成,無報錯。
2.打開doxygen軟件,File-Open-\doc\Doxyfiles\all_Doxyfile;
3.直接點擊run,生成文檔就能夠了。