Doxygen使用和DoxygenToolKit配置

最近嘗試了doxygen，還是很好用的，我在mac和linux下都進行了嘗試。效果都不錯。現在把使用的方法記錄下下來，給自己使用。

我自己的使用的情況主要是配合vim進行使用的，所以我還選擇了相應的插件DoxygenToolKit.vim，該插件還是挺容易上手的。

linux下安裝一下軟件
sudo apt-get install doxygen
sudo apt-get install doxygen-gui
sudo apt-get install graphviz

完成後運行doxywizard 就可以進行相應的配置，選擇相關的代碼之後進行操作。

mac就更簡單了，有doxygen.dmg大概是這個名字吧，在doxygen官網上有下載。

但是安裝了這些軟件之後還是不能直接使用的，需要給文件添加一些必要的註釋，否則不能輸出。所以DoxygenToolKit插件就產生了，通過進行配置可以生成相應的註釋。
注：在多次嘗試之後發現，修改一些變量之後，導出的文檔的質量會下降，比方說原來可以直接顯示爲參數，但是修改後變成了text,所以我除了添加函數頭，和author的賦值之外，其他沒有做配置。

效果不錯。

以下是網上找來的配置的代碼,大家可以酌情使用。

let g:DoxygenToolkit_briefTag_funcName="yes"
map <leader>da :DoxAuthor<CR>
map <leader>df :Dox<CR>
map <leader>db :DoxBlock<CR>
map <leader>dc a <LEFT><LEFT><LEFT>

let g:DoxygenToolkit_briefTag_funcName = "yes"

" for C++ style, change the '@' to '\'
"let g:DoxygenToolkit_commentType = "C++"
let g:DoxygenToolkit_briefTag_pre = "brief "
let g:DoxygenToolkit_templateParamTag_pre = "tparam "
let g:DoxygenToolkit_paramTag_pre = "param "
let g:DoxygenToolkit_returnTag = "return "
let g:DoxygenToolkit_throwTag_pre = "throw " " @exception is also valid
let g:DoxygenToolkit_fileTag = "file "
let g:DoxygenToolkit_dateTag = "date "
let g:DoxygenToolkit_authorTag = "author "
let g:DoxygenToolkit_versionTag = "version "
let g:DoxygenToolkit_blockTag = "name "
let g:DoxygenToolkit_classTag = "class "
let g:DoxygenToolkit_authorName = "zhuanghj"
let g:doxygen_enhanced_color = 1
"let g:load_doxygen_syntax = 1






let g:DoxygenToolkit_blockHeader="/****************************************************************************"
let g:DoxygenToolkit_blockFooter="****************************************************************************/"

let g:DoxygenToolkit_startCommentTag = ""
let g:DoxygenToolkit_interCommentTag = "*"
let g:DoxygenToolkit_endCommentTag = ""
let g:DoxygenToolkit_startCommentBlock = ""
let g:DoxygenToolkit_interCommentBlock = "* "
let g:DoxygenToolkit_endCommentBlock = ""