From: sung.goo.kim Date: Mon, 23 Nov 2015 05:03:34 +0000 (+0900) Subject: Apply comments (doxygen) X-Git-Tag: accepted/tizen/mobile/20151201.031626~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4ce229465c32940ba7bec3b2a0f055ebedd1b916;p=platform%2Fcore%2Fiot%2Fiotcon.git Apply comments (doxygen) Change-Id: I8f34c4d2f9d93722f6f4c4d55579b5a2705e7c3f --- diff --git a/doc/iotcon_doc.h b/doc/iotcon_doc.h index 53795e2..5fcffaf 100644 --- a/doc/iotcon_doc.h +++ b/doc/iotcon_doc.h @@ -27,8 +27,11 @@ * \#include * * @section CAPI_IOT_CONNECTIVITY_MODULE_OVERVIEW Overview - * The Iotcon API provides to register resources, discover resources and access them via - * RESTful API.\n\n + * The iotcon module provides various features based on Iotivity project.\n + * The IoTivity project is sponsored by the Open Interconnect Consortium + * a group of industry leaders who will be developing a standard specification and + * certification program to address these challenges.\n + * See http://iotivity.org and http://openinterconnect.org for more information. * * @subsection CAPI_IOT_CONNECTIVITY_MODULE_RESOURCE Resource * A Resource is a component in a server that can be viewed and conrolled by another client.\n diff --git a/lib/include/iotcon-observers.h b/lib/include/iotcon-observers.h index bcd721d..77d443f 100644 --- a/lib/include/iotcon-observers.h +++ b/lib/include/iotcon-observers.h @@ -146,7 +146,7 @@ int iotcon_observers_create(iotcon_observers_h *observers); void iotcon_observers_destroy(iotcon_observers_h observers); /** - * @brief Sets a observer id into the observers handle + * @brief Adds a observer id into the observers handle * * @since_tizen 3.0 * diff --git a/lib/include/iotcon-remote-resource.h b/lib/include/iotcon-remote-resource.h index 0b1bf4f..61d7560 100644 --- a/lib/include/iotcon-remote-resource.h +++ b/lib/include/iotcon-remote-resource.h @@ -665,6 +665,8 @@ int iotcon_remote_resource_get_types(iotcon_remote_resource_h resource, /** * @brief Gets resource interfaces of the remote resource + * @details @a ifaces can contain multiple interfaces like + * IOTCON_INTERFACE_LINK | IOTCON_INTERFACE_BATCH. * * @since_tizen 3.0 * diff --git a/lib/include/iotcon-representation.h b/lib/include/iotcon-representation.h index e4c9a90..4a0db1f 100644 --- a/lib/include/iotcon-representation.h +++ b/lib/include/iotcon-representation.h @@ -325,6 +325,8 @@ int iotcon_representation_set_resource_interfaces(iotcon_representation_h repr, /** * @brief Gets resource interfaces from the representation. + * @details @a ifaces can contain multiple interfaces like + * IOTCON_INTERFACE_LINK | IOTCON_INTERFACE_BATCH. * * @since_tizen 3.0 * diff --git a/lib/include/iotcon-resource-types.h b/lib/include/iotcon-resource-types.h index 5db481a..5f112f5 100644 --- a/lib/include/iotcon-resource-types.h +++ b/lib/include/iotcon-resource-types.h @@ -33,6 +33,7 @@ * * @section CAPI_IOT_CONNECTIVITY_COMMON_RESOURCE_TYPES_MODULE_OVERVIEW Overview * The iotcon resource types API provides methods for managing handle and add, remove resource types. + * A resource type indicates a class or category of resources. * * Example : * @code @@ -122,7 +123,7 @@ void iotcon_resource_types_destroy(iotcon_resource_types_h types); * Duplicate strings are not allowed. * * @param[in] types The handle of the resource types - * @param[in] type The string data to insert into the resource types + * @param[in] type The string data to insert into the resource types (e.g. "org.tizen.light") * * @return 0 on success, otherwise a negative error value. * @retval #IOTCON_ERROR_NONE Successful diff --git a/lib/include/iotcon-resource.h b/lib/include/iotcon-resource.h index 223dac3..7c49c1b 100644 --- a/lib/include/iotcon-resource.h +++ b/lib/include/iotcon-resource.h @@ -155,7 +155,7 @@ typedef void (*iotcon_request_handler_cb)(iotcon_resource_h resource, * @a ifaces can contain multiple interfaces like * IOTCON_INTERFACE_LINK | IOTCON_INTERFACE_BATCH.\n * @a properties also can contain multiple properties like - * IOTCON_RESOURCE_ACTIVE | IOTCON_RESOURCE_DISCOVERABLE.\n + * IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE.\n * iotcon_request_handler_cb() will be called when receive CRUD request to the registered * resource. * @@ -498,6 +498,8 @@ int iotcon_resource_get_types(iotcon_resource_h resource, iotcon_resource_types_ /** * @brief Gets the interfaces of the resource + * @a ifaces can contain multiple interfaces like + * IOTCON_INTERFACE_LINK | IOTCON_INTERFACE_BATCH. * * @since_tizen 3.0 * @@ -517,7 +519,9 @@ int iotcon_resource_get_types(iotcon_resource_h resource, iotcon_resource_types_ int iotcon_resource_get_interfaces(iotcon_resource_h resource, int *ifaces); /** - * @brief Checks whether the resource is observable or not. + * @brief Gets the properties in the resource + * @details @a properties can contain multiple properties like + * IOTCON_RESOURCE_DISCOVERABLE | IOTCON_RESOURCE_OBSERVABLE. * * @since_tizen 3.0 * diff --git a/lib/include/iotcon.h b/lib/include/iotcon.h index b3e37a2..ee37e1b 100644 --- a/lib/include/iotcon.h +++ b/lib/include/iotcon.h @@ -137,7 +137,8 @@ typedef void (*iotcon_connection_changed_cb)(bool is_connected, void *user_data) /** * @brief Adds a callback to Iotcon * @details When Iotcon connection status is changed with unexpected reason, registered - * callbacks will be called in turn. The handles are validate no more after broken connection. + * callbacks will be called in turn. The handles(e.g. iotcon_resource_h, + * iotcon_remote_resource_h, ...) are validate no more after broken connection. * The handles must creates again when connection recovered. * * @since_tizen 3.0