Update Cpp Api doxygen

Change-Id: I4ed23e32956980d816c3a7e6bb0605272df2782f
Signed-off-by: nikhil.a <nikhil.a7@samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/13145
Tested-by: jenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: Uze Choi <uzchoi@samsung.com>

diff --git a/service/notification/cpp-wrapper/provider/inc/NSConsumer.h b/service/notification/cpp-wrapper/provider/inc/NSConsumer.h
index 5a3b8c2..17ef502 100755 (executable)
--- a/service/notification/cpp-wrapper/provider/inc/NSConsumer.h
+++ b/service/notification/cpp-wrapper/provider/inc/NSConsumer.h
@@ -78,7 +78,7 @@ namespace OIC
 \r
                 /**\r
                       * This method is for setting icon image for the Notification service media contents.\r
-                      *\r
+                      * This function is valid only when subControllability is set true.\r
                       * @param accepted - as bool.\r
                       */\r
                 int acceptSubscription(bool accepted);\r

diff --git a/service/notification/cpp-wrapper/provider/inc/NSProviderService.h b/service/notification/cpp-wrapper/provider/inc/NSProviderService.h
index 1eb69bb..f96d239 100755 (executable)
--- 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:\r
                 /**\r
                       * Provider uses this callback function to receive subscription request of consumer\r
-                      * @param[in] consumer        Consumer who subscribes the resource\r
+                      * @param[in] consumer  Consumer who subscribes the notification message resource\r
                       */\r
                 typedef void (*ConsumerSubscribedCallback)(NSConsumer *);\r
 \r
                 /**\r
                       * Provider use this callback function to receive the status of the message\r
                       * synchronization\r
-                      * @param[in] sync        Synchronization information of the notification message\r
+                      * @param[in] sync Synchronization information of the notification message\r
                       */\r
                 typedef void (*MessageSynchronizedCallback)(NSSyncInfo *);\r
 \r
@@ -76,9 +76,9 @@ namespace OIC
 \r
                     /** subControllability - for setting the subscription controllability for Consumer */\r
                     bool subControllability;\r
-                    /** userInfo - user defined information */\r
+                    /** userInfo - user defined information such as device friendly name */\r
                     std::string userInfo;\r
-                    /* Set on/off with SECURED build option */\r
+                    /* Set on/off for secure resource channel setting */\r
                     bool resourceSecurity;\r
                 } ProviderConfig;\r
 \r
@@ -127,13 +127,13 @@ namespace OIC
 \r
                 /**\r
                       * Send read-check to provider in order to synchronize notification status with other consumers\r
-                      * @param[in]  messageId  Notification message to synchronize the status\r
+                      * @param[in]  messageId  ID of Notification message to synchronize the status\r
                       * @param[in]  type  NotificationSyncType of the SyncInfo message\r
                       */\r
                 void sendSyncInfo(uint64_t messageId, NSSyncInfo::NSSyncType type);\r
 \r
                 /**\r
-                     * Initialize NSMessage class, service sets message id and provider(device) id\r
+                     * Initialize NSMessage class, This function is valid only when subControllability is set true.\r
                      * @return NSMessage *\r
                      */\r
                 NSMessage *createMessage();\r