Eclipse 3.5 Galileo で Eclox (Doxygen) プラグインを使ってみる

前提として Eclox と Doxygen が正常にインストールされており、ソースコード中に Doxygen 対応のコメントが記入されていることが条件です。インストール方法はこちら。コメント記入方法はDoxygenやecloxとdoxygenで仕様書メンテナンスの効率をUP！で紹介されています。

１．Eclipseで、「ファイル」→「新規」→「その他...」で新規ウィザード上で「その他」を展開し、 Doxyfile を選択し[次へ]をクリックします。

２．Doxyfile name に適当な名前を入力し[完了]ボタンをクリックします。Doxyfile Name は（プロジェクト名）.doxyfile がわかりやすいかもしれませんね。

ここで
Doxygen Not Found Eclox was not able to run doxygen.Doxygen is either missing or eclox is not properly configured to use it.
なんてエラーが出た人はインストールが正常に行われていません。


３．作成された doxyfile を開き、基本タブと拡張タブに設定を行います。設定はここで紹介されているものをそのまま適用しました。設定が終了したらdoxyfileを保存します。

４．doxyfileを右クリックし、「@Build Documentation」を選択します。コンソールに「*** Build finished!」が表示されたら解析終了です。

５．設定時に Output Directory に指定したディレクトリに解析ファイルが出力されているので、確認してみましょう。Output Directory の下に作成された html ディレクトリの中に、 index.html があります。このファイルがトップページとなります。

index.html

私が出力できた例です。全てのファイルを解析対象にしていないので、解析が不十分なところもありますが、イメージを掴めれば。。。そんな程度で見てください。

 

Eclipse 3.5 Galileo に Eclox (Doxygen) プラグインを追加する

１．Eclipseを起動し、「ヘルプ」→「新規ソフトウェアのインストール...」を選びます。

２．インストールダイアログが表示されるので、[追加]ボタンをクリックします。

３．サイトの追加ダイアログが表示されるので、ロケーションに
http://download.gna.org/eclox/update
を入力し、OKボタンをクリックします。（名前は何でも構いません。）

４．ecloxにチェックを付け、[次へ]をクリックします。

５．インストール詳細ウィンドウが開くのでそのまま[次へ]をクリックします。

６．「使用条件の条項に同意します」を選択し、[完了]をクリックします。

７．Eclipseを再起動し、「ファイル」→「新規」→「その他...」で新規ウィザード上で「その他」を展開し、 Doxyfile があればインストール成功です。

さて、プラグインのインストールが出来たので、これで動作すると思いがち（私は思った）ですが、このままでは期待する動作を全くしてくれません。
このEcloxプラグインはDoxygenをEclipseで使えるようにしてくれる「橋渡し的な」存在なのです。
ですので、Doxygen本体は別にインストールしないといけない訳です。
私はMacユーザなのでMac用の説明をします。

８．http://www.stack.nl/~dimitri/doxygen/download.html ここから Doxygen-1.6.2.dmg をダウンロードします。
私はSnow Leopard ですが、現在対応していないので、 Leopard のものをダウンロードしました。

９．ダウンロードしたファイルをダブルクリックします。

１０．Doxygen.app の「パッケージの内容を表示」します。

１１．任意の場所にディレクトリを作成し、そこに /Contents/Resources/Doxygen のシンボリックリンクを作ります。（シンボリックリンクの作り方がどうしてもわからない場合は、/Contents/Resources/Doxygen をコピーでもいいです）

１２．Eclipse の「環境設定」→「Doxygen」を選択し、[追加]ボタンをクリックします。

１３．１１で作成したシンボリックリンクのあるディレクトリを指定します。（ちなみにWindowsの場合はDoxygen.exeのあるディレクトリを指定すれば良いらしい。確認してないですけど・・・）

これで使えるようになります。使い方はこちら。