對於Doxygen之前只聽別人說過,而如今使用它也是一個偶然,緣分吧。前兩天看box2d的官方sdk中,發現他有用戶手冊卻沒有說明,只是留下了一個Doxygen的文件。事情告一段落,而後今天在看box2d的例子的時候發現他的函數裏都有註釋即對函數的使用說明,這才讓我想起了Doxygen,有了它,能夠輕鬆生成本身最喜歡的chm格式的API文檔。並且網上的api文檔很差找。 html
csdn的教程連接:http://blog.csdn.net/flyoxs/article/details/7558175 api
這是給你們參考的至於今天我就給你們一個例子,用doxygen生成Box2d的api文檔。 函數
先下載doxygen的嚮導程序doxygenwizard,而後安裝,操做以下spa
下載地址能夠到上面的csdn博客中查找網址。 .net
file->open->box2d(你的box2d目錄)/documention->選擇doxygen的文件打開,隨便點幾個選項想發現人家已經幫你配置好了,這裏咱們直接生成。htm
run->run doxygen。等一會就會生成一堆html。這裏認爲html已經知足須要的就不用往下面看了。blog
以下圖: 教程
可是html格式不是我想要的,我須要的是一個pdf文檔和chm文檔因此須要進行下面的步驟:文檔
點擊wizard->output->prepared compress html(chm)博客
選中後在進行下面的設置:
CHMFILE爲你要生成程序的目錄。hhclocation即在微軟網上下載的
html help workshop,在其安裝目錄找到hhc.exe生成便可。
最後一步無關緊要:點擊 expert->output lauguage->chinse,他會把api中的一些文字改成中文的,不過用處不是很大。到此手裏會有一份關於box2d的chm格式文檔。