2010年1月22日金曜日

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

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

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


2.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.
なんてエラーが出た人はインストールが正常に行われていません。


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




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


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

index.html

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



 

0 件のコメント:

コメントを投稿