Merge pull request #256 from TakayukiHoshi1984/modify_sdk_doxygen

DConnectSDKのリファレンスの記載漏れを追加

Author: TakayukiHoshi1984

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/DConnectBatteryProfile.h

@@ -80,6 +80,10 @@ extern NSString *const DConnectBatteryProfileParamBattery;
  
  Battery Profileの各APIへのリクエストを受信する。
  受信したリクエストは各API毎にデリゲートに通知される。
+ 
+ @deprecated
+ 本クラスで定義していた定数はSwagger形式の定義ファイルで管理することになったので、このクラスは使用しないこととする。
+ プロファイルを実装する際は本クラスではなく、@link DConnectProfile @endlink クラスを継承すること。
  */
 @interface DConnectBatteryProfile : DConnectProfile
 

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectCanvasProfile.h

@@ -75,6 +75,10 @@ extern NSString *const DConnectCanvasProfileModeFills;
  
  Canvas Profileの各APIへのリクエストを受信する。
  受信したリクエストは各API毎にデリゲートに通知される。
+ 
+ @deprecated
+ 本クラスで定義していた定数はSwagger形式の定義ファイルで管理することになったので、このクラスは使用しないこととする。
+ プロファイルを実装する際は本クラスではなく、@link DConnectProfile @endlink クラスを継承すること。
  */
 @interface DConnectCanvasProfile : DConnectProfile
 

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectConnectionProfile.h

@@ -85,6 +85,10 @@ extern NSString *const DConnectConnectionProfileParamConnectStatus;
  
  Connect Profileの各APIへのリクエストを受信する。
  受信したリクエストは各API毎にデリゲートに通知される。
+ 
+ @deprecated
+ 本クラスで定義していた定数はSwagger形式の定義ファイルで管理することになったので、このクラスは使用しないこととする。
+ プロファイルを実装する際は本クラスではなく、@link DConnectProfile @endlink クラスを継承すること。
  */
 @interface DConnectConnectionProfile : DConnectProfile
 

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectDeviceOrientationProfile.h

@@ -85,6 +85,10 @@ extern NSString *const DConnectDeviceOrientationProfileParamAccelerationIncludin
  
  Device Orientation Profileの各APIへのリクエストを受信する。
  受信したリクエストは各API毎にデリゲートに通知される。
+ 
+ @deprecated
+ 本クラスで定義していた定数はSwagger形式の定義ファイルで管理することになったので、このクラスは使用しないこととする。
+ プロファイルを実装する際は本クラスではなく、@link DConnectProfile @endlink クラスを継承すること。
  */
 @interface DConnectDeviceOrientationProfile : DConnectProfile
 

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectFileDescriptorProfile.h

@@ -98,8 +98,12 @@ extern NSString *const DConnectFileDescriptorProfileParamPath;
  @class DConnectFileDescriptorProfile
  @brief File Descriptorプロファイル。
  
- File Descriptor Profileの各APIへのリクエストを受信する。
+ File Descriptor Profileの各APIへのリクエストを受信する｡
  受信したリクエストは各API毎にデリゲートに通知される。
+ 
+ @deprecated
+ 本クラスで定義していた定数はSwagger形式の定義ファイルで管理することになったので、このクラスは使用しないこととする。
+ プロファイルを実装する際は本クラスではなく、@link DConnectProfile @endlink クラスを継承すること。
  */
 @interface DConnectFileDescriptorProfile : DConnectProfile
 

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectFileProfile.h

@@ -113,6 +113,10 @@ typedef NS_ENUM(NSUInteger, DConnectFileProfileFileType) {
  
  File Profileの各APIへのリクエストを受信する。
  受信したリクエストは各API毎にデリゲートに通知される。
+ 
+ @deprecated
+ 本クラスで定義していた定数はSwagger形式の定義ファイルで管理することになったので、このクラスは使用しないこととする。
+ プロファイルを実装する際は本クラスではなく、@link DConnectProfile @endlink クラスを継承すること。
  */
 @interface DConnectFileProfile : DConnectProfile
 

dConnectSDK/dConnectSDKForIOS/DConnectSDK/DConnectSDK/DConnectGeolocationProfile.h

@@ -106,6 +106,10 @@ extern NSString *const DConnectGeolocationProfileParamTimeStampString;
  
  Geolocation Profileの各APIへのリクエストを受信する。
  受信したリクエストは各API毎にデリゲートに通知される。
+ 
+ @deprecated
+ 本クラスで定義していた定数はSwagger形式の定義ファイルで管理することになったので、このクラスは使用しないこととする。
+ プロファイルを実装する際は本クラスではなく、@link DConnectProfile @endlink クラスを継承すること。
  */
 @interface DConnectGeolocationProfile : DConnectProfile