`Xcode` から `HeaderDoc` を利用する方法

HeaderDocXcode から生成する

Build Phases から設定する

  • 対象のターゲットを選択して Build Phases > Add Build Phase > Add Build Phase > Add Run Script でスクリプトの項目を追加
  • Build Phases の項目に Run Script の項目が追加されているため以下のスクリプトをコピペする。

※テキストエディタからコピペする場合は改行コードが原因でうまく動かないことがあるので注意。改行ではなく文字だと判断されてしまいステートメントの単位がおかしくなったりする。

HEADER_DOC_DIR_NAME=documentation
HEADER_DOC_DIR=$HEADER_DOC_DIR_NAME
HEADER_DOC_DIR+=/
HEADER_DOC_DIR+=`date +%Y%m%d%k%M%S`
export LANG='ja_JP.UTF-8'
mkdir -p $HEADER_DOC_DIR
find . -name *.[hm] | xargs headerdoc2html -o $HEADER_DOC_DIR
gatherheaderdoc $HEADER_DOC_DIR

別ターゲットに記述する

デバッグなどに使用しているターゲットで行うとビルドに時間がかかってしまうので非常に鬱陶しい。なので別ターゲットを作成してスクリプトを走らせたほうがいい。

File -> New -> Target... -> iOS -> Aggregate を適当な名前をつけて作成し、Add Run Script してスクリプトを記述する。ドキュメントを生成したい時にはスキームを切り替えて、Command + B でビルドすればOK。

参考にしたサイト

Share
関連記事