Modify comments about connectivity API
authorEunyoung Lee <ey928.lee@samsung.com>
Wed, 16 Aug 2017 01:33:01 +0000 (10:33 +0900)
committerEunyoung Lee <ey928.lee@samsung.com>
Wed, 16 Aug 2017 01:33:01 +0000 (10:33 +0900)
Change-Id: Ic9848e7bf09bbf2498882c2a453c236df7adde37

inc/connectivity.h

index affff20..fc7962f 100644 (file)
@@ -32,25 +32,25 @@ struct connectivity_resource {
 typedef struct connectivity_resource connectivity_resource_s;
 
 /**
- * @brief Create connectivity resources and registers the resource in server.
+ * @brief Create connectivity resource and registers the resource in server.
  * @param[in] uri_path The URI path of the resource
  * @param[in] type The string data to insert into the resource types (e.g. "org.tizen.light")
- * @param[out] out_resource_info A structure containing information about connectivity resources
+ * @param[out] out_resource_info A structure containing information about connectivity resource
  * @return 0 on success, otherwise a negative error value
  * @see uri_path length must be less than 128.
- * @see You must destroy resource by calling iotcon_resource_destroy() if resource is no longer needed.
+ * @see You must destroy resource by calling connectivity_unset_resource() if resource is no longer needed.
  */
 extern int connectivity_set_resource(const char *uri_path, const char *type, connectivity_resource_s **out_resource_info);
 
 /**
- * @brief Releases all resources about connectivity.
- * @param[in] resource_info A structure containing information about connectivity resources
+ * @brief Releases all resource about connectivity.
+ * @param[in] resource_info A structure containing information about connectivity resource
  */
 extern void connectivity_unset_resource(connectivity_resource_s *resource);
 
 /**
  * @brief Notifies specific clients that resource's attributes have changed with boolean vaule.
- * @param[in] resource_info A structure containing information about connectivity resources
+ * @param[in] resource_info A structure containing information about connectivity resource
  * @param[in] key A new key to be added into attributes
  * @param[in] value A boolean value to be added into attributes
  * @return 0 on success, otherwise a negative error value
@@ -60,7 +60,7 @@ extern int connectivity_notify_bool(connectivity_resource_s *resource_info, cons
 
 /**
  * @brief Notifies specific clients that resource's attributes have changed with int vaule.
- * @param[in] resource_info A structure containing information about connectivity resources
+ * @param[in] resource_info A structure containing information about connectivity resource
  * @param[in] key A new key to be added into attributes
  * @param[in] value A int value to be added into attributes
  * @return 0 on success, otherwise a negative error value
@@ -70,7 +70,7 @@ extern int connectivity_notify_int(connectivity_resource_s *resource_info, const
 
 /**
  * @brief Notifies specific clients that resource's attributes have changed with double vaule.
- * @param[in] resource_info A structure containing information about connectivity resources
+ * @param[in] resource_info A structure containing information about connectivity resource
  * @param[in] key A new key to be added into attributes
  * @param[in] value A double value to be added into attributes
  * @return 0 on success, otherwise a negative error value