Explain set of enum concretely

Change-Id: I1881ccc8f1e3e26345919aa243c6a6e57191963a
Signed-off-by: youngman <yman.jung@samsung.com>

diff --git a/lib/include/iotcon-lite-resource.h b/lib/include/iotcon-lite-resource.h
index 42743aceba58f3315e624f30445691a51770b2d2..4bbe3347d2c9dc0cbef9768a7b20bf376d06e077 100644 (file)
--- a/lib/include/iotcon-lite-resource.h
+++ b/lib/include/iotcon-lite-resource.h
@@ -133,6 +133,8 @@ static void _update_brightness(int brightness)
  * @details Registers a resource specified by @a uri_path, @a res_types, @a state which have
  * @a properties in Iotcon server.\n
  * When client requests some operations, it send a response to client, automatically.\n
+ * The @a properties can contain multiple properties like
+ * IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE.
  *
  * @since_tizen 3.0
  * @privlevel public
@@ -142,10 +144,10 @@ static void _update_brightness(int brightness)
  * You must destroy @a resource_handle by calling iotcon_lite_resource_destroy()
  * if @a remote_handle is no longer needed.
  *
- * @param[in] uri_path The URI path of the resource.
- * @param[in] res_types The list of type of the resource.
- * @param[in] properties The property of the resource.
- * @param[in] state The state handle to set.
+ * @param[in] uri_path The URI path of the resource
+ * @param[in] res_types The list of type of the resource
+ * @param[in] properties The property of the resource\n Set of #iotcon_resource_property_e
+ * @param[in] state The state handle to set
  * @param[out] resource_handle The handle of the resource
  *
  * @return 0 on success, otherwise a negative error value.

diff --git a/lib/include/iotcon-remote-resource.h b/lib/include/iotcon-remote-resource.h
index 8be2c22bb62c30a4310718196846d9baa0910c77..455a2bfa41c9f3b826f2103d7a7434181f6b4fa5 100644 (file)
--- a/lib/include/iotcon-remote-resource.h
+++ b/lib/include/iotcon-remote-resource.h
@@ -101,7 +101,9 @@ static void _find_light_resource()
  * observe the object.\n
  * If not, you should discover the resource object manually.\n
  * The @a properties can contain multiple properties like
- * IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE.
+ * IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE.\n
+ * The @a ifaces can contain multiple interfaces like
+ * IOTCON_INTERFACE_LINK | IOTCON_INTERFACE_BATCH.
  *
  * @since_tizen 3.0
  *
@@ -110,10 +112,11 @@ static void _find_light_resource()
  *
  * @param[in] host_address The host address of the resource
  * @param[in] connectivity_type The connectivity type
- * @param[in] uri_path The URI path of the resource.
- * @param[in] properties The properties of the resource
+ * @param[in] uri_path The URI path of the resource
+ * @param[in] properties The properties of the resource\n Set of #iotcon_resource_property_e
  * @param[in] resource_types The resource type of the resource. For example, "core.light"
- * @param[in] resource_ifaces The resource interfaces (whether it is collection etc)
+ * @param[in] resource_ifaces The resource interfaces (whether it is collection etc)\n
+ * Set of #iotcon_interface_e
  * @param[out] remote_resource Generated resource handle
  *
  * @return 0 on success, otherwise a negative error value.
@@ -485,7 +488,7 @@ int iotcon_remote_resource_stop_caching(iotcon_remote_resource_h resource);
  * @param[in] state The state of the remote resource
  * @param[in] user_data The user data to pass to the function
  *
- * @pre The callback must be registered using iotcon_remote_resource_start_monitoring()\n
+ * @pre The callback must be registered using iotcon_remote_resource_start_monitoring()
  *
  * @see iotcon_remote_resource_start_monitoring()
  * @see iotcon_remote_resource_stop_monitoring()
@@ -674,7 +677,7 @@ int iotcon_remote_resource_get_types(iotcon_remote_resource_h resource,
  * @since_tizen 3.0
  *
  * @param[in] resource The handle of the remote resource
- * @param[out] ifaces The resource interfaces of the remote resource
+ * @param[out] ifaces The resource interfaces of the remote resource\n Set of #iotcon_interface_e
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #IOTCON_ERROR_NONE  Successful
@@ -698,7 +701,7 @@ int iotcon_remote_resource_get_interfaces(iotcon_remote_resource_h resource, int
  * @since_tizen 3.0
  *
  * @param[in] resource The handle of the resource
- * @param[out] properties The Properties of the resource
+ * @param[out] properties The Properties of the resource\n Set of #iotcon_resource_property_e
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #IOTCON_ERROR_NONE  Successful

diff --git a/lib/include/iotcon-representation.h b/lib/include/iotcon-representation.h
index 4a0db1faf7b59628856c8a78a5bc9f3ff74935b6..e15d53cf82350c10ebbd541554ebe8633497e34b 100644 (file)
--- a/lib/include/iotcon-representation.h
+++ b/lib/include/iotcon-representation.h
@@ -314,7 +314,7 @@ int iotcon_representation_get_resource_types(iotcon_representation_h repr,
  * @since_tizen 3.0
  *
  * @param[in] repr The representation handle
- * @param[in] ifaces The interfaces to set
+ * @param[in] ifaces The interfaces to set\n Set of #iotcon_interface_e
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #IOTCON_ERROR_NONE  Successful
@@ -331,7 +331,7 @@ int iotcon_representation_set_resource_interfaces(iotcon_representation_h repr,
  * @since_tizen 3.0
  *
  * @param[in] repr The representation handle
- * @param[out] ifaces The interfaces to get
+ * @param[out] ifaces The interfaces to get\n Set of #iotcon_interface_e
  *
  * @return Interfaces to get. Interfaces may contain multiple interfaces.
  * @retval #IOTCON_INTERFACE_NONE  Not set

diff --git a/lib/include/iotcon-resource.h b/lib/include/iotcon-resource.h
index f9c8b1f128fefb9ae078cbe36e5254b5f39ffc5d..b8f25dc3cc7e4b68ecaebb10b75c1c4b448b7f15 100644 (file)
--- a/lib/include/iotcon-resource.h
+++ b/lib/include/iotcon-resource.h
@@ -167,10 +167,10 @@ typedef void (*iotcon_request_handler_cb)(iotcon_resource_h resource,
  * You must destroy @a resource by calling iotcon_resource_destroy()
  * if @a resource is no longer needed.
  *
- * @param[in] uri_path The URI path of the resource.
- * @param[in] res_types The list of type of the resource.
- * @param[in] ifaces The interfaces of the resource.
- * @param[in] properties The properties of the resource.
+ * @param[in] uri_path The URI path of the resource
+ * @param[in] res_types The list of type of the resource
+ * @param[in] ifaces The interfaces of the resource\n Set of #iotcon_interface_e
+ * @param[in] properties The properties of the resource\n Set of #iotcon_resource_property_e
  * @param[in] cb The request handler callback function
  * @param[in] user_data The user data to pass to the callback function
  * @param[out] resource_handle The handle of the resource
@@ -504,7 +504,7 @@ int iotcon_resource_get_types(iotcon_resource_h resource, iotcon_resource_types_
  * @since_tizen 3.0
  *
  * @param[in] resource The handle of the resource
- * @param[out] ifaces The interfaces of the resource
+ * @param[out] ifaces The interfaces of the resource\n Set of #iotcon_interface_e
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #IOTCON_ERROR_NONE  Successful
@@ -526,7 +526,7 @@ int iotcon_resource_get_interfaces(iotcon_resource_h resource, int *ifaces);
  * @since_tizen 3.0
  *
  * @param[in] resource The handle of the resource
- * @param[out] properties The properties of resource
+ * @param[out] properties The properties of resource\n Set of #iotcon_resource_property_e
  *
  * @return 0 on success, otherwise a negative error value.
  * @retval #IOTCON_ERROR_NONE  Successful