From cde620e4586d435daa88e4d9e7d214d955ed4a9f Mon Sep 17 00:00:00 2001 From: "nikhil.a" Date: Wed, 12 Oct 2016 14:54:33 +0530 Subject: [PATCH] Update Cpp Api doxygen Change-Id: I4ed23e32956980d816c3a7e6bb0605272df2782f Signed-off-by: nikhil.a Reviewed-on: https://gerrit.iotivity.org/gerrit/13145 Tested-by: jenkins-iotivity Reviewed-by: Uze Choi --- service/notification/cpp-wrapper/provider/inc/NSConsumer.h | 2 +- .../cpp-wrapper/provider/inc/NSProviderService.h | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/service/notification/cpp-wrapper/provider/inc/NSConsumer.h b/service/notification/cpp-wrapper/provider/inc/NSConsumer.h index 5a3b8c2..17ef502 100755 --- a/service/notification/cpp-wrapper/provider/inc/NSConsumer.h +++ b/service/notification/cpp-wrapper/provider/inc/NSConsumer.h @@ -78,7 +78,7 @@ namespace OIC /** * This method is for setting icon image for the Notification service media contents. - * + * This function is valid only when subControllability is set true. * @param accepted - as bool. */ int acceptSubscription(bool accepted); diff --git a/service/notification/cpp-wrapper/provider/inc/NSProviderService.h b/service/notification/cpp-wrapper/provider/inc/NSProviderService.h index 1eb69bb..f96d239 100755 --- a/service/notification/cpp-wrapper/provider/inc/NSProviderService.h +++ b/service/notification/cpp-wrapper/provider/inc/NSProviderService.h @@ -48,14 +48,14 @@ namespace OIC public: /** * Provider uses this callback function to receive subscription request of consumer - * @param[in] consumer Consumer who subscribes the resource + * @param[in] consumer Consumer who subscribes the notification message resource */ typedef void (*ConsumerSubscribedCallback)(NSConsumer *); /** * Provider use this callback function to receive the status of the message * synchronization - * @param[in] sync Synchronization information of the notification message + * @param[in] sync Synchronization information of the notification message */ typedef void (*MessageSynchronizedCallback)(NSSyncInfo *); @@ -76,9 +76,9 @@ namespace OIC /** subControllability - for setting the subscription controllability for Consumer */ bool subControllability; - /** userInfo - user defined information */ + /** userInfo - user defined information such as device friendly name */ std::string userInfo; - /* Set on/off with SECURED build option */ + /* Set on/off for secure resource channel setting */ bool resourceSecurity; } ProviderConfig; @@ -127,13 +127,13 @@ namespace OIC /** * Send read-check to provider in order to synchronize notification status with other consumers - * @param[in] messageId Notification message to synchronize the status + * @param[in] messageId ID of Notification message to synchronize the status * @param[in] type NotificationSyncType of the SyncInfo message */ void sendSyncInfo(uint64_t messageId, NSSyncInfo::NSSyncType type); /** - * Initialize NSMessage class, service sets message id and provider(device) id + * Initialize NSMessage class, This function is valid only when subControllability is set true. * @return NSMessage * */ NSMessage *createMessage(); -- 2.7.4