ツヨシのブログ

技術的な事とか日常の事とか徒然なるままに

AppleDocについて(その2)

AppleDocのインストールが終わりましたので、次に実際のプロジェクトを使ってAppleDocを使ってみたいと思います。 今回使用するプロジェクトにAFNetworkingを使用ました。これは、WEB APIを簡単に使用するためのライブラリで、githubで公開されています。また、コメントがAppleDodで書かれているようなので、今回はこれを使用しました。

プロジェクトの取得

適当なディレクトリに移動してgithubよりAFNetworkingを取得します。

git clone git://github.com/AFNetworking/AFNetworking.git

ドキュメント生成コマンド

ドキュメントを生成するための基本的なコマンドは下記のようになります。

~/appledoc -p [PROJECT_NAME]-c [COMPANY_NAME] [OUTPUT_DOCUMENTS] -o [OUTPUT_DIR] [SOURCE_DIR]

この時、Xcodeのドキュメントを作成する場合と、HTMLのドキュメントを作成する場合では[OUTPUT_DOCUMENTS]部分のオプションが異なります。

HTMLドキュメントを作成する場合

~/appledoc -p [PROJECT_NAME]-c [COMPANY_NAME] --create-html-o [OUTPUT_DIR] [SOURCE_DIR]

XCodeドキュメントを作成する場合

~/appledoc -p [PROJECT_NAME]-c [COMPANY_NAME] --create-docset-o [OUTPUT_DIR] [SOURCE_DIR]

例えば先ほど取得したAFNetworking直下で、HTMLのドキュメントを場合には次のようになります。 ※ドキュメント出力用のディレクトリ(docs)は先に作っておく必要があります。

appledoc -p testAFNetworking -c mokemoke.inc--create-html -o./docs/ ./AFNetworking

生成したドキュメント

「./docs/docset-installed.txt」というファイルが出来上がっているかと思います。この中に作成したドキュメントのアドレスがあります。上記の場合ですと次のアドレスが指定されているかと思います。

Documentation set was installed to Xcode!

Path: /Users/[ユーザ名]/Library/Developer/Shared/Documentation/DocSets/com.mokemoke.inc.testafnetworking.testAFNetworking.docset
Time: 2014-01-11 14:44:34 +0000 

上記のアドレスに飛び、さらに以下のファイルによりHTMLの形式のAPIドキュメントが作成されています。

./Contents/Resources/Documents/index.html

このファイルをブラウザなどで見ることにより作成されたドキュメントを確認することができます。 このようにしてAppleDocを使うことにより、ソース中のコメントを解析してドキュメントを作成することができます。

Xcodeのドキュメント

また、Xcodeのドキュメントについてはオプションを「--create-docset」と指定することで作成することができます。作成したドキュメントはXCodeの「HELP」->「Documentation and API Reference」より確認することができます。ただし、確認する際には作成後XCodeを再起動する必要があるようです。

詳細! Objective-C iPhoneアプリ開発 入門ノート Xcode5+iOS7対応

詳細! Objective-C iPhoneアプリ開発 入門ノート Xcode5+iOS7対応