doxygen是幫助改進(jìn)工程結(jié)構(gòu)和相關(guān)優(yōu)化的工具,能夠提供工程類調(diào)用關(guān)系圖和函數(shù)調(diào)用關(guān)系圖。
主要需要下面這些操作:
1) doxygen, 2)Graphviz,圖形化可視軟件,3)iconv,中文編碼轉(zhuǎn)化工具。
將這些安裝好以后,打開doxygen主界面選擇expert.進(jìn)行相關(guān)配置,其中要配置的信息包括:1)project,主要是工程名稱和版本以及輸出目錄,這里關(guān)系到chm文檔第一頁顯示的標(biāo)題。2)Build,主要是選擇顯示的模式,比如Extract_ALL:將顯示程序所有的元素:類,函數(shù),變量;Extract_PRIVATE:顯示私有變量等。3)Message,warn_logfile項(xiàng)目里面可以給出出錯(cuò)以及相關(guān)的編譯log,之后的編譯信息都將在這個(gè)對(duì)應(yīng)的log文件里面找到。4)Input,主要是輸出你要生成軟件文檔的工程,這里要給出目錄。5)source browser,代碼瀏覽器,是否可以瀏覽到代碼。6)HTML,如果要產(chǎn)生CHM文檔的話,那么就一定得要選擇generate_htmlhelp,7)dot, 這里主要是要選擇CLASS_DIAGRAMS,UML_LOOK,CALL_GRAPH,CALLER_GRAPH.等顯示類結(jié)構(gòu)圖,uml圖,被調(diào)用者關(guān)系圖,調(diào)用者關(guān)系圖。
之后做一些選擇就可以生成doxyfile的東西,按照這個(gè)doxyfile的東西就可以生成相應(yīng)的配置信息,doxyfile是doxygen的配置信息,是可以被編輯的。
配置好之后,就可以生成相關(guān)的html文件,png文件等。
之后再用chm打包成chm文件,方便查閱。
這里可以借助其它的打包軟件來處理這些,因?yàn)閔tml打包的容量有限,并且doxygen生成的html有時(shí)候也有問題,比如關(guān)聯(lián)的東西太多了,就會(huì)產(chǎn)生很多麻煩,比如html無法正常產(chǎn)生,我有次就產(chǎn)生以后,發(fā)現(xiàn)其中的html字節(jié)都為0KB,很郁悶,chm來打包也是很有問題的,打包東西太多了,就sb了,所以做到這點(diǎn)可以用doxygen+打包軟件(未必是chm文件).
一些其他有用信息可以在這里獲得:
http://www.fmddlmyy.cn/text21.html