OData Client for Objective-CのAPIリファレンス

OData Client for Objective-C（http://odataobjc.codeplex.com/）であるが、配布しているものをダウンロードしてみると、ライブラリのバイナリ＆ソースコードとサンプルアプリ、ユーザガイドが入っている。

このユーザガイドを見ればなんとなくの使い方はわかるものの、ユーザガイドに書いてあることとちょっとでも違うことをやろうとすると、なんと「APIリファレンスが無い」ことに気付く。

ライブラリとして配布しているのに、APIリファレンスがないとはなんということだと思うものの、ちょっと冷静になってソースコードを見ていると。。。

/**
 * To add a filter query option.
 *
 * @param <string> expression
 * @return <DataServiceQuery> Self reference that includes the requested
 *                            filter option
 * @throws DataServiceRequestException
 */
- (DataServiceQuery*) filter:(NSString*)anExpression
{
    return [self addQueryOption:@"$filter" query:anExpression];
}

なんと、ソースコードの中にはちゃんとAPIリファレンスが書かれていました！しかも、この記述形式がDoxygenのものっぽいなと思い、試しにDoxygenでドキュメントを吐き出させてみると、しっかりAPIリファレンスが出力されます。

まぁ、全てのメソッドにリファレンスが付いているわけではないものの、このライブラリを使う際にコード上で触る範囲のものにはだいたい書かれている感じです。

ということで、作成したAPIリファレンスを置いておきます。

odataobjc-v1.1-apidoc.zip