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