寫C代碼時,用慣了doxygen,現在寫lua代碼,也特別地希望用doxygen,上官網看了看,真發現有lua的filter
git clone https://github.com/alecchen/doxygen-lua.git 這個源即可獲取,不過貌似人家沒有管Windows什麼事,perl腳本,所有東西都是Linux的
好在我們有cygwin,在cygwin中安裝上perl和doxygen後,依然不能按照他說的辦法安裝,錯誤信息大約是找不到 Install.pm之類的,
經研究發現,其實是可以這樣的:
- cp -r doxygen-lua/lib/Doxygen /lib/perl5/5.10/ 將整個Doxygen文件夾拷貝到perl的庫文件夾中
- perldoc Doxygen::Lua 如果有輸出幫助信息,說明拷貝正確
- cp doxygen-lua/bin/lua2dox /usr/bin/ 這是最終要用到的腳本,放path中去
-
在Doxyfile中加上這麼一句:FILTER_PATTERNS = *.lua=lua2dox 即可
驗證:
- cd doxygen-lua/example
- 修改 FILTER_PATTERNS = *.lua=../bin/lua2dox => FILTER_PATTERNS = *.lua=lua2dox
- doxygen 執行doxygen
- 查看html
貌似腳本的功能有限。而且我覺得既然是Lua的Filter,就應該用Lua來寫,這樣也好讓人加入,現在用perl,讓我這個完全不懂perl的情何以堪啊~~