From 0cc67e8581aaa2dfc1eb205a0fd0b4965116a77f Mon Sep 17 00:00:00 2001 From: DoHyun Pyun Date: Wed, 23 Oct 2019 16:59:30 +0900 Subject: [PATCH] Fix Native API reference issues Change-Id: I8744694749b8f635e66cc7d69e65986dad64dee2 Signed-off-by: DoHyun Pyun --- include/iotcon-lite-resource.h | 2 +- include/iotcon-remote-resource.h | 5 ++--- include/iotcon-resource.h | 4 ++-- include/iotcon-server.h | 1 - 4 files changed, 5 insertions(+), 7 deletions(-) diff --git a/include/iotcon-lite-resource.h b/include/iotcon-lite-resource.h index d6166d3..6cc8946 100644 --- a/include/iotcon-lite-resource.h +++ b/include/iotcon-lite-resource.h @@ -161,7 +161,7 @@ typedef bool (*iotcon_lite_resource_post_request_cb)(iotcon_lite_resource_h reso * @brief Creates a lite resource handle and registers the resource in server. * @details Registers a resource specified by @a uri_path, @a res_types, @a attributes which have @a properties in IoTCon server. \n * When client requests some operations, it send a response to client, automatically.\n - * The @a policies can contain multiple policies like IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE. + * The @a policies can contain multiple policies like #IOTCON_RESOURCE_DISCOVERABLE | #IOTCON_RESOURCE_OBSERVABLE. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/internet diff --git a/include/iotcon-remote-resource.h b/include/iotcon-remote-resource.h index a102f20..942735e 100644 --- a/include/iotcon-remote-resource.h +++ b/include/iotcon-remote-resource.h @@ -110,7 +110,7 @@ static void _find_light_resource() * API can be used without discovering the object in advance.\n * To use this API, you should provide all of the details required to correctly contact and observe the object.\n * If not, you should discover the resource object manually.\n - * The @a policies can contain multiple policies like IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE. + * The @a policies can contain multiple policies like #IOTCON_RESOURCE_DISCOVERABLE | #IOTCON_RESOURCE_OBSERVABLE. * @since_tizen 3.0 * @remarks You must destroy @a remote_resource by calling iotcon_remote_resource_destroy() if @a remote_resource is no longer needed. * @param[in] host_address The host address of the resource @@ -603,7 +603,6 @@ int iotcon_remote_resource_get_device_id(iotcon_remote_resource_h resource, char * @see iotcon_remote_resource_get_connectivity_type() * @see iotcon_remote_resource_get_types() * @see iotcon_remote_resource_get_interfaces() - * @see iotcon_remote_resource_get_properties() * @see iotcon_remote_resource_set_options() */ int iotcon_remote_resource_get_device_name(iotcon_remote_resource_h resource, char **device_name); @@ -657,7 +656,7 @@ int iotcon_remote_resource_get_interfaces(iotcon_remote_resource_h resource, iot /** * @brief Checks whether the remote resource is observable or not. - * @details The @a policies can contain multiple policies like IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE. + * @details The @a policies can contain multiple policies like #IOTCON_RESOURCE_DISCOVERABLE | #IOTCON_RESOURCE_OBSERVABLE. * @since_tizen 3.0 * @param[in] resource The handle of the resource * @param[out] policies The policies of the resource \n diff --git a/include/iotcon-resource.h b/include/iotcon-resource.h index 384bcf1..13a255d 100644 --- a/include/iotcon-resource.h +++ b/include/iotcon-resource.h @@ -197,7 +197,7 @@ typedef void (*iotcon_request_handler_cb)(iotcon_resource_h resource, iotcon_req * @a uri_path format would be relative URI path like '/a/light' \n * @a res_types is a list of resource types. Create a iotcon_resource_types_h handle and add types string to it. \n * @a ifaces is a list of resource interfaces. Create a iotcon_resource_interfaces_h handle and add interfaces string to it. \n - * @a policies also can contain multiple policies like IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE. \n + * @a policies also can contain multiple policies like #IOTCON_RESOURCE_DISCOVERABLE | #IOTCON_RESOURCE_OBSERVABLE. \n * iotcon_request_handler_cb() will be called when receive CRUD request to the registered resource. * @since_tizen 3.0 * @privlevel public @@ -528,7 +528,7 @@ int iotcon_resource_get_interfaces(iotcon_resource_h resource, iotcon_resource_i /** * @brief Gets the policies in the resource. - * @details @a policies can contain multiple policies like IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE. + * @details @a policies can contain multiple policies like #IOTCON_RESOURCE_DISCOVERABLE | #IOTCON_RESOURCE_OBSERVABLE. * @since_tizen 3.0 * @param[in] resource The handle of the resource * @param[out] policies The policies of resource \n diff --git a/include/iotcon-server.h b/include/iotcon-server.h index 001470c..f361875 100644 --- a/include/iotcon-server.h +++ b/include/iotcon-server.h @@ -106,7 +106,6 @@ int iotcon_stop_presence(void); * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory * @retval #IOTCON_ERROR_IOTIVITY Iotivity errors - * @see iotcon_get_device_info() * @see iotcon_device_info_get_property() * @see iotcon_remote_resource_get_device_name() */ -- 2.7.4