Objective-Cのソースコードのコメントからドキュメントが自動生成できる 『Doxygen』

Doxygenはソースコードのコメントからドキュメントを自動生成するツールです。JavaでいうJavadocのイメージです。MacのXcode4でコーディングしたObjective-CのソースコードをDoxygenで出力してみました。


Doxygenのダウンロード
DoxygenのURLにアクセスします。
http://www.stack.nl/~dimitri/doxygen/

DownloadよりDoxygen-1.7.6.1.dmgをダウンロードします。

設定と操作
Doxygenを起動すると、「Doxygen GUI fronted +」のウィンドウが開きます。

Step 1:Specify the working directory from which doxygen will run
適当な作業ディレクトリを指定します。

Step 2:Configure doxygen using the Wizard and/or Expert tab, then switch to the Run tab to generate the documentation

[Wizard]タブ

Project name:
→プロジェクト名を入力します。

Source code directory:
→ソースファイルの保存場所を指定します。「Scan recursively」にチェックを入れると、指定したフォルダ以下のソースファイルもドキュメント出力対象にします。

Destination directory:
ドキュメントの出力フォルダを指定します。


[Expert]タブ

JAVADOC_AUTOBRIEFにチェックを入れると、Javadocのスタイルを適用することができます。


[Run]タブ

[Run doxygen]ボタンでドキュメントを生成し、[Show HTML output]ボタンでドキュメントを開きます。


ソースコードと実行結果
UIImageクラスを利用してiPhoneアプリに画像を表示するで作成したヘッダファイル（Hello.h）に次のようなコメントを記述しました。

/**
 * @brief "Hello World"表示
 * @author yosinoo
 */

#import <UIKit/UIKit.h>

@interface Hello : UIView {
    UIImage* _image;
}

@end

[Run doxygen]ボタンを押すと、次のようなドキュメントが生成されました。