appledocの導入方法

　何度か使用しているappledocなのですが、毎回導入手順等の記録を疎かにしてしまうので、ここらで私なりの手順まとめてみようと思います。

　1.そもそもappledocって何？
　appledocを使用すると、ソースコードのコメントからAPIドキュメントを自動生成することができます。Apple社のリファレンスに似せたドキュメントが生成されるため、iOS等の技術者に取っ付きやすいフォーマットで出力されます。JavadocのObjective-c版という感じでしょうか。

　2.導入手順
　2-1.appledocのインストール
　いろいろ手順はあるのですが、今回はGithubからソース取得＆コンパイルしてみます。
ソースのダウンロード
　git clone git://github.com/tomaz/appledoc.git

ダウンロードできたらコンパイルします。
　shdo sh install-appledoc.sh

これでappledocコマンドが実行出来ます。

　2-2.Xcodeからappledocを使用する
　ターミナルからもappledocを使用できるのですが、コードを修正する度（APIリファレンスを作成する度）にコマンドを叩くのは若干手間がかかります。ですので、Xcodeから実行出来るようにしてみます。
　まず、プロジェクトを選択し、画面下のAddTargetを選択してAggregateを作成します。すると作成したTarget（Scheme）が追加されます。
　追加したTargetを選択し、画面右下の『Add Build Phase』の『Add Run Script』を選択します。







Run Scriptに以下のScriptを入力します。（Ctr+zの戻るコマンドは使えないので注意！！）
appledoc --project-name [プロジェクト名] --project-company [会社名] --company-id [会社のID] --create-html --no-create-docset --output  [アウトプット先]  [ソースコード場所]



以上で、HtmlやXcodeから参照できるDocsetを出力できます。

細かいオプションについては、述べませんでしたが…、機会があればいずれ記事を書ければと思います。



今回、実装した開発環境は以下になります。

［開発環境］
・Xcode4.6
・appledoc2.2

コメント

コメントを投稿

このブログの人気の投稿

HealKit HKObjectType 一覧

イメージ
　iOS8からHealthKitが使用できるようになりました。このHealthKit使用することで様々なヘルスデータを管理できます。これらのデータへアクセスする場合、アプリ内で各データへのアクセスをユーザーに確認しなければなりません。確認するには以下のメソッドを使用するのですが、アクセスするデータのタイプがわかりにくかったので一覧にまとめてみました。 ※確認を行った端末はiOS8.2になります。 HealthKitデータへのアクセス確認メソッド - (void)requestAuthorizationToShareTypes:(NSSet *)typesToShare readTypes:(NSSet *)typesToRead completion:(void (^)(BOOL success, NSError *error))completion; HealthKitデータへのアクセス確認画面 HealthKitデータタイプ一覧 QuantityTypeIdentifier 表示名 HKQuantityTypeIdentifierBodyMassIndex ボディマス指数（BMI) HKQuantityTypeIdentifierBodyFatPercentage 体脂肪率 HKQuantityTypeIdentifierHeight 身長 HKQuantityTypeIdentifierBodyMass 体重 HKQuantityTypeIdentifierLeanBodyMass 除脂肪体重 HKQuantityTypeIdentifierStepCount 歩数 HKQuantityTypeIdentifierDistanceWalkingRunning ウォーキング＋ランニング HKQuantityTypeIdentifierDistanceCycling 自転車の走行距離 HKQuantityTypeIdentifierBasalEnergyBurned 基礎代謝量 HKQuantityTypeIdentifierActiveEnergyBurned アクティブカロリー HKQuantity
続きを読む

クラッシュ時のスタックトレース取得方法

iOS開発において、クラッシュした場所の検討がつかない場合がありました。 いろいろ調べてみると、NSSetUncaughtExceptionHandlerにハンドラ関数のポインタを渡すと、クラッシュ時のスタックトレースが取得できるようです。 以下のコードはその実装例。 @implementation AppDelegate void exceptionHandler(NSException *exception) { NSLog(@"Exception: %@", exception); NSLog(@"Stack Trace: %@", [exception callStackSymbols]); } - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { NSSetUncaughtExceptionHandler(&exceptionHandler); return YES; } @end 以下のコードで無理やりExceptionを発生してみました。 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { NSSetUncaughtExceptionHandler(&exceptionHandler); //無理やりEcxeptionを発生させる。 NSArray *array = [NSArray array]; [array objectAtIndex:1]; return YES; } 出力結果は以下。 2013-07-15 19:21:45.415 ExceptionSample[27437:c07] Exception: *** -[__NSArrayI objectAtIndex:]: index 1 beyond bounds for empty array
続きを読む

Undefined symbols for architecture arm64

イメージ
cocoapodsを久しぶりに使用したら以下のエラーが出た。 Undefined symbols for architecture arm64:   "_OBJC_CLASS_$_AFHTTPResponseSerializer", referenced from:       objc-class-ref in xxxxxxxxxxx.o うーん。 どうやらPodsで作成されたライブラリ(.a)とアプリとで、『Architecture』違うぞって言われてる模様。 試行錯誤した結果、BuildSetting -> Architecture の『Standard architectures ( including 64-bit) (armv7,armv7s,arm64)』を『Standard architectures (armv7,armv7s)』に変更するするとビルドエラーを回避できました。 ※ 上記では、アプリ側のArchitectureを変更していますが、逆にPodsプロジェクトのArchitectureにarm64を追加することでもビルドエラーを回避することができます。
続きを読む