(ACR) Add doxygen for asynchronous API
authorsung.goo.kim <sung.goo.kim@samsung.com>
Wed, 4 Nov 2015 06:12:50 +0000 (15:12 +0900)
committerYoungjae Shin <yj99.shin@samsung.com>
Thu, 5 Nov 2015 00:41:02 +0000 (09:41 +0900)
Change-Id: I7b4d359c7815a022e89843040860d75b91ac7f6d

lib/include/iotcon-client.h
lib/include/iotcon-remote-resource.h

index 1dcea71..e1669c5 100644 (file)
@@ -144,7 +144,7 @@ typedef void (*iotcon_found_resource_cb)(iotcon_remote_resource_h resource,
                iotcon_error_e result, void *user_data);
 
 /**
- * @brief Finds resources.
+ * @brief Finds resources, asynchronously.
  * @details Request to find a resource of @a host_address server with @a resource_type.\n
  * @a host_address could be #IOTCON_MULTICAST_ADDRESS for IPv4 multicast.\n
  * If succeed to find the resource, iotcon_found_resource_cb() will be invoked with
@@ -202,7 +202,7 @@ typedef void (*iotcon_device_info_cb)(iotcon_device_info_h device_info,
                iotcon_error_e result, void *user_data);
 
 /**
- * @brief Gets the device information of remote server.
+ * @brief Gets the device information of remote server, asynchronously.
  * @details Request device information to server and pass the information by calling
  * iotcon_device_info_cb().\n
  * @a host_address could be #IOTCON_MULTICAST_ADDRESS for IPv4 multicast.\n
@@ -277,7 +277,7 @@ typedef void (*iotcon_platform_info_cb)(iotcon_platform_info_h platform_info,
                iotcon_error_e result, void *user_data);
 
 /**
- * @brief Gets the platform information of remote server.
+ * @brief Gets the platform information of remote server, asynchronously.
  * @details Request platform information to server and pass the information by calling
  * iotcon_platform_info_cb().\n
  * @a host_address could be #IOTCON_MULTICAST_ADDRESS for IPv4 multicast.\n
@@ -354,7 +354,7 @@ typedef void (*iotcon_tizen_info_cb)(iotcon_tizen_info_h tizen_info,
                iotcon_error_e result, void *user_data);
 
 /**
- * @brief Gets the tizen device information of remote server.
+ * @brief Gets the tizen device information of remote server, asynchronously.
  * @details Request tizen device information to server and pass the information by calling
  * iotcon_tizen_info_cb().\n
  * If succeed to getting tizen information, iotcon_tizen_info_cb() will be invoked with
index bd0598a..8ac2245 100644 (file)
@@ -199,7 +199,7 @@ int iotcon_remote_resource_start_observing(iotcon_remote_resource_h resource,
 int iotcon_remote_resource_stop_observing(iotcon_remote_resource_h resource);
 
 /**
- * @brief Gets the attributes of a resource.
+ * @brief Gets the attributes of a resource, asynchronously.
  * @details When server sends response on get request, iotcon_remote_resource_response_cb() will be called.
  *
  * @since_tizen 3.0
@@ -229,7 +229,7 @@ int iotcon_remote_resource_get(iotcon_remote_resource_h resource, iotcon_query_h
                iotcon_remote_resource_response_cb cb, void *user_data);
 
 /**
- * @brief Puts the representation of a resource
+ * @brief Puts the representation of a resource, asynchronously.
  * @details When server sends response on put request, iotcon_remote_resource_response_cb() will be called.
  *
  * @since_tizen 3.0
@@ -263,7 +263,7 @@ int iotcon_remote_resource_put(iotcon_remote_resource_h resource,
                void *user_data);
 
 /**
- * @brief Posts on a resource
+ * @brief Posts on a resource, asynchronously.
  * @details When server sends response on post request, iotcon_remote_resource_response_cb() will be called.
  *
  * @since_tizen 3.0
@@ -297,7 +297,7 @@ int iotcon_remote_resource_post(iotcon_remote_resource_h resource,
                void *user_data);
 
 /**
- * @brief Deletes a resource.
+ * @brief Deletes a resource, asynchronously.
  * @details When server sends response on delete request, iotcon_remote_resource_response_cb() will be called.
  *
  * @since_tizen 3.0