[Dash][doxygen]doxygenで生成したドキュメントをDashで読む

Dashは速くて便利なドキュメントブラウザ兼スニペット管理ソフト

Dashはosx用のドキュメントブラウザ兼スニペット管理ソフトで、検索速度が抜群に速いです。
Dash – Documentation Browser, Snippet Manager – Kapeli http://kapeli.com/dash

自前のdocsetを生成する方法

代表的な言語やライブラリのドキュメント（docset）はDash上から直接ダウンロードして認識させることができますが、提供されていないものは自前でdocsetを作る必要があります。docsetの作り方は次のサイトに設定や手順が詳しく記載されています。

Generating Dash Docsets – Kapeli http://kapeli.com/docsets

doxygenの場合docsetが簡単に作れる

今回、私はC++で作成されたライブラリのソースコードからドキュメントを生成したかったので、doxygenからdocsetを作ってみることにしました。幸いにもdoxygenの場合はオプションを変更すればさほど手を煩わす必要もなくdocsetを作ってくれるようです。

 GENERATE_DOCSET   = YES
 DISABLE_INDEX     = YES 
 SEARCHENGINE      = NO
 GENERATE_TREEVIEW = NO

なお、osx用にはdoxygenのGUIフロントエンドのDoxywizardがあるので、今回はこれを利用して見ようかと思います。

Doxygen: Downloads http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

Doxywizardでdocsetを生成

通常、Step1とStep2のWizardタブとRunタブに従えばhtmlやtexのドキュメントを簡単に作成できますが、今回はゴールがdocsetを生成する事にあるので、さらにExpertタブを開き、先のオプションを変更します。

※同様に、DISABLE_INDEX, SEARCHENGINE, GENERATE_TREEVIEWを設定

設定が完了したらRunタブに切り替えて、 Run Doxygen ボタンをクリックして実行します。

なお、この操作ではまだ docsetが生成されてない 状態なので、コンソールからhtmlディレクトリに移動して、そこでmakeします。

$ cd html
$ make

すると org.doxygen.Project.docset というファイルが生成されますので、適当な名前にリネームして適当な場所に移動します。

$ mv org.doxgen.Project.docset ~/path/to/file.docset

Dashに生成したdocsetを認識させる

Dashのプリファレンスから Docset タブを開き、先ほど生成したdocsetを追加します。

Dashで検索してみる

表示されました。快適。

追記：
option + click でDash上のドキュメントを表示するプラグインを入れるとさらに快適です。

Dash Plugin for Xcode
https://github.com/Kapeli/Dash-Plugin-for-Xcode

Alcatraz
http://alcatraz.io/
パッケージマネージャ。VisualStudioのNuGetやvimのvundleやxyzzyのnetinstaller..(ry のように手軽にプラグインを管理できる。