XCode4でAppleDoc形式のドキュメントを自動的に作成する

前のエントリーでappledocをインストールしておきます。

プロジェクトの直下に AppledocSetting.plist という名前で設定ファイルを作成します。

AppledocSetting.plist

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>--company-id</key>
        <string>com.luckyandhappy</string>
        <key>--create-docset</key>
        <true/>
        <key>--ignore</key>
        <array>
            <string>ThirdParty</string>
            <string>Libraries</string>
            <string>Frameworks</string>
            <string>Testing</string>
        </array>
        <key>--install-docset</key>
        <true/>
        <key>--output</key>
        <string>/tmp</string>
        <key>--project-company</key>
        <string>Lucky &amp; Happy Company</string>
        <key>--project-name</key>
        <string>SOAP2JSON</string>
        <key>--keep-undocumented-objects</key>
        <true/>
        <key>--keep-undocumented-members</key>
        <true/>
        <key>--warn-undocumented-object</key>
        <false/>
        <key>--warn-undocumented-member</key>
        <false/>
        <key>--warn-empty-description</key>
        <false/>
        <key>--warn-missing-arg</key>
        <false/>
        <key>--warn-unknown-directive</key>
        <true/>
    </dict>
</plist>

--company-id, --project-name, --project-companyは自分の環境に合わせて変更して下さい。

ターゲットを追加します。

スクリプトを追加します。

プロダクトのビルドが実行されるたびに、ドキュメントを更新するには、Product/Edit Schemeを編集します。

ドキュメント化するソースコードが多い場合、ビルドするたびにスクリプトが実行されるので重くなるかもしれません。そんなときは最後の手順をやめて、ターゲットをドキュメントとプロダクトで別々にビルドできるようにしておいたほうが良いかも。