Osaka.vim#3の進捗です。
目的
コードを書いている時にこそドキュメントを手早く参照したいもの。
doxygenは優秀なドキュメントジェネレータだが
該当するページに行くための検索機能が十分であるとは言い難い。
さらに言えばコードはvimで書いているのでvimから直接検索できればなお良い。
そこでunite.vimを使用してdoxygenのページを検索し、
そのままブラウザで開くためのプラグインを作成した。
unite-doxygen
基本設計
Doxygen v1.8.3で追加された外部検索用の機能を使用する。
Doxygenからドキュメントのデータが入ったsearchdata.xml
を生成し、
XSLTで平文に変換してunite.vimのソースに取り込む。
使い方
- Doxygenでパースできるドキュメントが書いてあるプロジェクトを用意します
- libxsltをインストール
doxygen
コマンドでsearchdata.xml
を生成する。 そのためには以下のオプションをDoxyfile内で有効化(=YES)する。 これでOUTPUT_DIRECTORYで指定されているディレクトリにsearchdata.xml
ができる。.vimrc
にOUTPUT_DIRECTORYのフルパスを書く。vim
let g:unite_doxygen_home = "/full/path/of/OUTPUT_DIRECTORY"vim上で
:Unite doxygen
を実行する
追記
- Xalanのかわりにlibxslt(xsltproc)を使用するように変更