Update C API doxygen

[platform/upstream/iotivity.git] / service / notification / include / NSProviderInterface.h

diff --git a/service/notification/include/NSProviderInterface.h b/service/notification/include/NSProviderInterface.h
index 305fec6..0616233 100644 (file)
--- a/service/notification/include/NSProviderInterface.h
+++ b/service/notification/include/NSProviderInterface.h
@@ -37,15 +37,15 @@ extern "C"
 #include <stdint.h>\r
 \r
 /**\r
- * Invoked when a consumer requests subscription.\r
- * @param[in] consumer        Consumer who subscribes the resource\r
+ * Invoked when provider receives the subscription request of consumer.\r
+ * @param[in] consumer  Consumer who subscribes the notification message resource\r
  */\r
 typedef void (*NSSubscribeRequestCallback)(NSConsumer *);\r
 \r
 /**\r
- * Invoked when synchronization data which has notification message \r
+ * Invoked when synchronization data which has notification message\r
  * read/deleted event from consumer is received.\r
- * @param[in] sync        Synchronization information of the notification message\r
+ * @param[in] sync  Synchronization information of the notification message\r
  */\r
 typedef void (*NSProviderSyncInfoCallback)(NSSyncInfo *);\r
 \r
@@ -58,14 +58,16 @@ typedef struct
     NSSubscribeRequestCallback subRequestCallback;\r
     /* Invoked when the synchronization data, read and deleted, is sent by consumer is received */\r
     NSProviderSyncInfoCallback syncInfoCallback;\r
-    /* Set the policy for notification servcie refering to following\r
-     * if true, the controllability such as subscription request and consumer topic selection\r
-     * is owned by provider user. Otherwise(policy is false), consumer user has the same.\r
+    /* Set the policy for notification servcie which checks whether provider is capable of \r
+     * denying the subscription of notification message from consumer\r
+     * and getting controllabliity to set consumer topic list.\r
+     * If true, provider is able to control subscription request and consumer topic list.\r
+     * Otherwise(policy is false), consumer can do the same.\r
      */\r
     bool subControllability;\r
-    /* User Information */\r
+    /* User defined information such as device friendly name */\r
     char * userInfo;\r
-    /* Set on/off with SECURED build option */\r
+    /* Set on/off for secure resource channel setting */\r
     bool resourceSecurity;\r
 \r
 } NSProviderConfig;\r
@@ -106,30 +108,25 @@ NSResult NSSendMessage(NSMessage * msg);
 \r
 /**\r
  * Send acceptance to consumer who subscribes the resource of notification message\r
+ * This function is valid only when subControllability is set true.\r
  * @param[in]  consumer  Consumer who subscribes the resource\r
- * @param[in]  accepted  the result of acceptance; Allow or Deny\r
- * @return ::NS_OK if the action is requested succesfully or NS_FAIL if subContollability is false.\r
+ * @param[in]  accepted  the result of acceptance; ALLOW or DENY\r
+ * @return ::NS_OK if this function is requested succesfully\r
+ * or NS_FAIL if subContollability is false.\r
  */\r
 NSResult NSAcceptSubscription(const char * consumerId, bool accepted);\r
 \r
 /**\r
- * Get consumer list that is stored in the cache of notification service\r
- * @param[in]  list  Consumer list\r
- * @param[in]  size  the number of consumers stored in the cache\r
- * @return ::NS_OK or result code of NSResult\r
- */\r
-//TODO will use Function.\r
-// NSResult NSGetConsumerList(uint8_t *list, uint32_t size);\r
-\r
-/**\r
  * Send synchronizad state of notificaion message to consumers\r
- * @param[in]  message  Notification message to synchronize the status\r
+ * @param[in]  messageiId  ID of notification message\r
+ * @param[in]  type  SyncType of the syncInfo message\r
  * @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.\r
  */\r
 NSResult NSProviderSendSyncInfo(uint64_t messageId, NSSyncType type);\r
 \r
 /**\r
- * Initialize NSMessage struct, provider service sets generated message id and provider(device) id\r
+ * Initialize NSMessage struct.\r
+ * Service sets mandatory fields which message id and provider(device) id are filled with.\r
  * @return ::NSMessage *\r
  */\r
 NSMessage * NSCreateMessage();\r