読者です 読者をやめる 読者になる 読者になる

Natural Software

KinectなどのDepthセンサーを中心に活動しています

Doxygen プラグイン

Trac Hudson

先日の勉強会での昼食時にかぬさんからコレいいよと教えてもらった Doxygen プラグインを試してみた。


こんなカンジで Trac の一部として Doxygen で生成されたドキュメントを見ることが出来ます。

インストール

ダウンロードとインストールはこちらのページを参照した。
ソースをダウンロードし、

svn checkout http://trac-hacks.org/svn/doxygenplugin


egg ファイルを作る。

python setup.py bdist_egg


dist フォルダに作成された egg ファイルを Trac にインストールし、プラグインを有効にする。
インストールと有効化は Trac の管理画面から行った。


設定

インストールと有効化が終わると、メニューと管理画面に「Doxygen」が現れる。
今回設定した項目は下記の2つ

  1. encoding:utf-8
  2. path:サーバ上の Doxygen フォルダ(main.html があるフォルダ)

Doxgen ファイルの作成

今回は Doxygen ファイルを Hudson で作成することにした。
Hudoson の Doxygen プラグインがあるので、それを使おうと思ったが上手く動かず、調べても出てこないので、仕方なくコマンドプロンプトから動作させた(このあたりの柔軟さが Hudoson の強みだと思う:) )。


ちなみに、ソースのエンコードが Shift-JIS なので、UTF-8 で表示させるためにちょっと細工。
nkf.exe を使ってエンコードを変更する。

エンコードの変更

上記サイトから nkf.exe をダウンロードしパスを通す。
Doxygen の設定ファイルの下記項目を変更する。

FILTER_SOURCE_FILES = YES
INPUT_FILTER = "nkf -w8"

まとめ

こんなカンジで
ソース修正 → コミット → ビルド(テスト) → ドキュメント生成 → Trac で確認
がシームレスに出来るようになった:)
実際、Trac で表示されるフォーマットが崩れてる(css が適用されてないのかな?)とか、Doxygen で生成されるドキュメント自体が、個人的に見づらいことを除けば便利なプラグインだと思う:)