XCode + HeaderDocによるドキュメント生成
最近iPhoneアプリをひたすら作っててふと思った。
「なんかJavaDocみたいなのほしいな。。。」とか。
Javaを書くときはJavaDocでもろもろ書いてるんだけど、iPhoneアプリはObjective-Cなので、どうせなら新しいドキュメンテーションツールを使ってみたいなぁと思って調べてみたら、HeaderDocなるものを見つけた。
JavaDocみたいな感じで書いて、わりといろんな言語にも対応してるらしい。
そこそこ書きやすそうだったので導入してみた。
MacにDeveloperToolを入れると勝手に入るらしく、headerdoc2htmlやgatherheaderdocといったコマンドで生成できるらしい。
しかもテンプレートいじるといろいろできるらしく、ちょっと遊びがいがありそうな感じ。
ついでなのでXcodeのビルドプロセスが実行されたタイミングでHTMLが生成されるように設定してみた。
まず左側のペイン［グループとファイル］で［ターゲット］->｛プロジェクト名｝の順に展開していく。
次に｛プロジェクト名｝を右クリックし、［追加］->［新規ビルドフェーズ］->［新規スクリプトを実行］を選択する。
そうすると情報ウインドウが表示されるので、その中の［スクリプト］ペインに
mkdir -p apiDoc
find . -name \*.h -print | xargs headerdoc2html -o apiDoc
gatherheaderdoc apiDocこれでビルドをかければその都度ソースコードに記述されたHeaderDocからHTMLが生成される。
なお、生成されたHTMLはプロジェクトディレクトリのapiDoc内に存在しているはず。
テンプレートつけないと味気ない感じは否めないですが。。。。
