doxygen這個工具摸了有幾天了,從上周的最開始接觸,搞不懂怎么用,挺煩的,到昨天晚上利用它將OGRE源代碼中的注釋生成成HTML幫助文檔,感覺這東西還真是挺好用的啊。
當然,這里提一句,生成幫助文檔里的類關系圖,需要用到GraphViz工具,當然不用也可以,不過我覺得挺好的東西,用用吧還是,顯得專業。安裝完GraphViz后,要重啟電腦,因為會將程序路徑添加到Path中,改變了環境變量。
準備工作:
1、電腦安裝過CMake,Doxygen和GraphViz,且已重啟過。
2、有OGRE源碼,假設是D:\OGRE\。
切入主題:
如何利用CMake生成OGRE的解決方案,我不詳述,只提一點,在CMake里勾選OGRE_INSTALL_DOCS這一項。生成的OGRE解決方案,會包含一個名為doc的項目,這就是生成api文檔的項目。運行這個項目,自然就會生成api的html幫助文檔了。
上面所說的這些,都是表面上的操作,而實際的工作是這樣完成的:
如下圖所示:
html.cfg是一個配置文件,可以用doxygen將其打開。在這個文件里,設置了用doxygen將ogre源代碼文件中的注釋生成html幫助的參數。比如下面這幾個圖,基本表示出了主要的幾個有用參數。
最后這張圖,是查看配置后的參數,以及點擊Run,生成html。
至于,如何將生成的html再用HTML Help Workshop生成chm。可以查閱網上相關資料。