DConnectSDKのリファレンスを追記。

Author: masaru-takano

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectApiEntity.h

@@ -14,10 +14,30 @@
 
 typedef BOOL (^DConnectApiFunction)(DConnectRequestMessage*, DConnectResponseMessage*);
 
+/*!
+ @class DConnectApiEntity
+ @brief Device Connect APIを実装するオブジェクト。
+ */
 @interface DConnectApiEntity : NSObject<NSCopying>
+
+/*!
+ @brief APIのメソッド名。
+ */
 @property (nonatomic, strong) NSString *method;
+
+/*!
+ @brief APIのパス名。
+ */
 @property (nonatomic, strong) NSString *path;
+
+/*!
+ @brief APIを実装するブロック。
+ */
 @property (nonatomic, strong) DConnectApiFunction api;
+
+/*!
+ @brief APIの仕様を定義するオブジェクトのインスタンス。
+ */
 @property (nonatomic, strong) DConnectApiSpec *apiSpec;
 
 @end

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectApiSpec.h

@@ -12,27 +12,66 @@
 #import <DConnectSDK/DConnectRequestMessage.h>
 #import <DConnectSDK/DConnectSpecConstants.h>
 
+/*!
+ @class DConnectApiSpec
+ @brief Device Connect API仕様。
+ */
 @interface DConnectApiSpec : NSObject<NSCopying>
 
+/*!
+ @brief API種別。
+ */
 @property(nonatomic) DConnectSpecType type;
 
+/*!
+ @brief APIメソッド。
+ */
 @property(nonatomic) DConnectSpecMethod method;
 
+/*!
+ @brief API名。
+ */
 @property(nonatomic, strong) NSString *apiName;
 
+/*!
+ @brief プロファイル名。
+ */
 @property(nonatomic, strong) NSString *profileName;
 
+/*!
+ @brief インターフェース名。
+ */
 @property(nonatomic, strong) NSString *interfaceName;
 
+/*!
+ @brief アトリビュート名。
+ */
 @property(nonatomic, strong) NSString *attributeName;
 
-// DConnectParamSpecの配列
+
+/*!
+ @brief リクエストパラメータ仕様のリスト。
+ 
+ DConnectParamSpecの配列で表現される。
+ */
 @property(nonatomic, strong) NSArray *requestParamSpecList;
 
+/*!
+ @brief APIのパスを取得する。
+ @return APIのパスを示す文字列。
+ */
 - (NSString *) path;
 
+/*!
+ @brief APIのパスを設定する。
+ @param[in] path APIのパスを示す文字列。
+ */
 - (void) setPath: (NSString *) path;
 
+/*!
+ @brief アプリケーションからのリクエストを検証する。
+ @return リクエストが仕様通りであると判断された場合はYES、そうでない場合はNO
+ */
 - (BOOL) validate: (DConnectRequestMessage *) request;
 
 @end

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectAvailabilityProfile.h

@@ -21,6 +21,13 @@ extern NSString *const DConnectAvailabilityProfileName;
 
 extern NSString *const DConnectAvailabilityProfileParamName;
 
+/*!
+ @class DConnectAvailabilityProfile
+ @brief Availabilityプロファイル。
+ 
+ Managerと通信可能であることを確認するためのプロファイル。
+ プラグイン側では実装する必要はない。
+ */
 @interface DConnectAvailabilityProfile : DConnectProfile
 
 - (id) init;

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectPluginSpec.h

@@ -10,6 +10,12 @@
 #import <Foundation/Foundation.h>
 #import "DConnectProfileSpec.h"
 
+/*!
+ @class DConnectPluginSpec
+ @brief プラグインのサポートする仕様を保持するクラス。
+ 
+ プラグインのサポートするプロファイルのリストを持つ。
+ */
 @interface DConnectPluginSpec : NSObject
 
 /*!

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectProfileProvider.h

@@ -10,6 +10,10 @@
 #import <Foundation/Foundation.h>
 #import <DConnectSDK/DConnectProfile.h>
 
+/*!
+ @class DConnectProfileProvider
+ @brief Device Connect プロファイルプロバイダー。
+ */
 @interface DConnectProfileProvider : NSObject
 
 /*!

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectProfileSpec.h

@@ -12,14 +12,32 @@
 #import "DConnectSpecConstants.h"
 #import "DConnectProfileSpec.h"
 
+/*!
+ @class DConnectProfileSpec
+ @brief プロファイルについての仕様を保持するクラス。
+ 
+ 当該プロファイル上で定義されるAPIの仕様のリストを持つ。
+ */
 @interface DConnectProfileSpec : NSObject
 
+/*!
+ @brief API仕様定義ファイルの元データ。
+ */
 @property (nonatomic, strong) NSDictionary * bundle;
 
+/*!
+ @brief API名。
+ */
 @property (nonatomic, strong) NSString * api;
 
+/*!
+ @brief プロファイル名.
+ */
 @property (nonatomic, strong) NSString * profile;
 
+/*!
+ @brief 当該プロファイルのもつDConnectApiSpec一覧。
+ */
 @property (nonatomic, strong) NSMutableDictionary * allApiSpecs;    // Map<String, Map<Method, DConnectApiSpec>>
 
 

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectService.h

@@ -17,35 +17,73 @@ extern NSString * const DConnectServiceAnonymousOrigin;
 extern NSString * const DConnectServiceInnerType;
 extern NSString * const DConnectServiceInnerTypeHttp;
 
-
 @class DConnectService;
 
+/*!
+ @brief DConnectServiceの状態変更通知を受信するリスナー。
+ */
 @protocol OnStatusChangeListener <NSObject>
 
+/*!
+ @brief DConnectServiceの状態が変更された時に呼び出される。
+ @param[in] 状態の変更されたDConnectServiceのインスタンス。
+ */
 - (void) didStatusChange: (DConnectService *)service;
 
 @end
 
+/*!
+ @class DConnectService
+ @brief Device Connect APIサービス。
+ */
 @interface DConnectService : DConnectProfileProvider<DConnectServiceInformationProfileDataSource>
 
 /*!
- @brief サービスID.
+ @brief サービスID。
  */
 @property(nonatomic, strong) NSString *serviceId;
 
+/*!
+ @brief サービス名。
+ */
 @property(nonatomic, strong) NSString *name;
 
+/*!
+ @brief ネットワーク種別。
+ */
 @property(nonatomic, strong) NSString *networkType;
 
+/*!
+ @brief オンライン状態。
+ 
+ ホストデバイスと接続されているかどうかを示すフラグ。
+ */
 @property(readwrite, getter=online, setter=setOnline:) BOOL online;
 
+/*!
+ @brief コンフィグ。
+ 
+ サービスごとに任意に設定可能な文字列。
+ */
 @property(nonatomic, strong) NSString *config;
 
+/*!
+ @brief 当該サービスの状態変更を通知するリスナー。
+ */
 @property(nonatomic, weak) id<OnStatusChangeListener> statusListener;
 
-
+/*!
+ @brief DConnectServiceのインスタンスを生成する。
+ @param[in] serviceId サービスID。
+ @param[in] plugin DConnectDevicePluginのインスタンス。
+ @return DConnectServiceのインスタンス。
+ */
 - (instancetype) initWithServiceId: (NSString *)serviceId plugin: (id) plugin;
 
+/*!
+ @brief リクエスト受信時に実行される。
+ @return 同期的にリクエストを処理する場合はYES、それ以外の場合(非同期処理を行う場合)はNO。後者の場合は、非同期処理完了後に明示的にレスポンス送信処理を実行すること。
+ */
 - (BOOL) didReceiveRequest: (DConnectRequestMessage *) request response: (DConnectResponseMessage *)response;
 
 @end

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectServiceListViewController.h

@@ -11,14 +11,30 @@
 #import <DConnectSDK/DConnectSystemProfile.h>
 #import <DConnectSDK/DConnectServiceListener.h>
 
+/*!
+ @class DConnectServiceListViewController
+ @brief DeviceConnectサービス一覧を表示するUI。
+ */
 @interface DConnectServiceListViewController : UITableViewController<DConnectServiceListener>
 
+/*!
+ @brief Systemプロファイルのデリゲート。
+ */
 @property (nonatomic, weak) id<DConnectSystemProfileDelegate> delegate;
 
+/*!
+ @brief サービス追加ボタン。
+ */
 @property (weak, nonatomic) IBOutlet UIBarButtonItem *addButton;
 
+/*!
+ @brief サービス追加または削除の完了ボタン。
+ */
 @property (weak, nonatomic) IBOutlet UIBarButtonItem *finishButton;
 
+/*!
+ @brief サービス削除ボタン。
+ */
 @property (weak, nonatomic) IBOutlet UIBarButtonItem *removeButton;
 
 @end

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectServiceListener.h

@@ -9,13 +9,28 @@
 
 @class DConnectService;
 
+/*!
+ @brief サービス一覧の状態変更通知を受信するリスナー。
+ */
 @protocol DConnectServiceListener <NSObject>
 @optional
 
+/*!
+ @brief サービスが追加された時に実行される。
+ @param[in] 追加されたサービス。
+ */
 - (void) didServiceAdded: (DConnectService *) service;
 
+/*!
+ @brief サービスが削除された時に実行される。
+ @param[in] 削除されたサービス。
+ */
 - (void) didServiceRemoved: (DConnectService *) service;
 
+/*!
+ @brief サービスの状態が変更された時に実行される。
+ @param[in] 状態の変更されたサービス。
+ */
 - (void) didStatusChange: (DConnectService *) service;
 
 @end

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectServiceManager.h

@@ -12,6 +12,10 @@
 #import <DConnectSDK/DConnectServiceProvider.h>
 #import <DConnectSDK/DConnectPluginSpec.h>
 
+/*!
+ @class DConnectServiceManager
+ @brief 当該プラグインのDeviceConnectサービスを管理する。
+ */
 @interface DConnectServiceManager : DConnectServiceProvider<OnStatusChangeListener>
 
 
@@ -29,6 +33,10 @@
  */
 + (DConnectServiceManager *)sharedForKey: (NSString *)key;
 
+/*!
+ @brief プラグインを対応づける。
+ @param[in] plugin DConnectDevicePluginのインスタンス。
+ */
 - (void) setPlugin: (id) plugin;
 
 @end