From: saerome.kim Date: Fri, 24 Mar 2017 10:13:03 +0000 (+0900) Subject: Fix ACR issue X-Git-Tag: submit/tizen/20170512.045637~16 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8459932ad56bac0a96d181faa406c14ef5a21504;p=platform%2Fcore%2Fapi%2Fzigbee.git Fix ACR issue - remove @remarks fileds in zigbee.h - modifying the contents of the zigbee_doc.h Change-Id: I961b72c7f5ad561d793f30d879b80a2d5fb20b6c Signed-off-by: saerome.kim --- diff --git a/doc/zigbee_doc.h b/doc/zigbee_doc.h old mode 100755 new mode 100644 index 65a711b..4408b2c --- a/doc/zigbee_doc.h +++ b/doc/zigbee_doc.h @@ -26,12 +26,19 @@ * \#include * * @section CAPI_NETWORK_ZIGBEE_MODULE_OVERVIEW Overview - * ZigBee is the wireless language that everyday devices use to connect to one another. - * ZigBee devices can transmit data over long distances by passing data through a mesh network - * of intermediate devices to reach more distant ones. - * ZigBee is typically used in low data rate applications that require long battery life and secure networking. \n\n - * ZigBee has a defined rate of 250 kbit/s, best suited for intermittent data transmissions - * from a sensor or input device. \n See http://www.zigbee.org for more information.\n\n + * Zigbee service consists of @ref CAPI_NETWORK_ZIGBEE_ZDO_MODULE and + * @ref CAPI_NETWORK_ZIGBEE_ZCL_MODULE.\n + * In order to use the above APIs, you must call @ref zb_create() in advance. + * In addition, @ref zb_destroy() should be called when Zigbee service is no longer needed.\n + * You can also see our @ref CAPI_NETWORK_ZIGBEE_MODULE_REFERENCE for more detailed + * descriptions of our library methods.\n\n + * Note on callbacks: All callbacks in this module are called in the main loop context.\n + * + * @subsection CAPI_NETWORK_ZIGBEE_MODULE_REFERENCE Zigbee Reference + * - http://www.zigbee.org/ + * - http://www.zigbee.org/download/standards-zigbee-specification/ + * - http://www.zigbee.org/download/standards-zigbee-cluster-library/ + * - http://www.zigbee.org/zigbee-for-developers/applicationstandards/zigbeehomeautomation/ * * @section CAPI_NETWORK_ZIGBEE_MODULE_FEATURE Related Features * This API is related with the following features:\n @@ -122,12 +129,6 @@ static void _init_zigbee_service(...) printf(" - zb_set_event_cb() ret: [0x%X]", ret); - ret = zb_enable(handle, zigbee_enable_cb); - if (ZIGBEE_ERROR_NONE != ret) { - printf("zb_enable ret=[0x%x]\n", ret); - return; - } - ret = zb_form_network(handle, zigbee_form_network_done_cb, NULL); if (ZIGBEE_ERROR_NONE != ret) { printf(" - zb_form_network ret=[0x%x]\n", ret); @@ -310,7 +311,7 @@ static int _run_off(zigbee_h handle) * * @subsection CAPI_NETWORK_ZIGBEE_MODULE_RECEIVING_EVENT_FROM_DEVICES Receiving Events From the Devices * If an IAS zone sensor such as an open / close sensor is joined to the network, - * the following attribute changed notification event can be received when an open / close event occurs. + * the following attribute changed notification event can be received when an open / close event occurs. * * Example : * @code @@ -404,12 +405,6 @@ static int _run_disable(zigbee_h handle) // De-register event callback int ret = ZIGBEE_ERROR_NONE; - ret = zb_disable(handle); - if (ZIGBEE_ERROR_NONE != ret) { - printf("zb_disable(0x%X) - FAILED!!!", ret); - return ret; - } - printf(" - zb_disable() ret: [0x%X]", ret); if (NULL == handle) { diff --git a/include/zigbee.h b/include/zigbee.h index 9559cb5..22983f7 100644 --- a/include/zigbee.h +++ b/include/zigbee.h @@ -48,9 +48,6 @@ extern "C" { * * @since_tizen 4.0 * - * @remarks You must free all resources of the zigbee by calling zigbee_disconnect() - * if zigbee service is no longer needed. - * * @param[out] handle The handle of zigbee * * @return 0 on success, otherwise a negative error value. @@ -70,9 +67,6 @@ int zb_create(zigbee_h *handle); * * @since_tizen 4.0 * - * @remarks You must free all resources of the zigbee by calling zb_disconnect() - * if zigbee service is no longer needed. - * * @param[in] handle The handle of zigbee * * @return 0 on success, otherwise a negative error value. @@ -130,9 +124,6 @@ typedef void (*zb_event_cb)(nwk_addr addr16, ieee_addr addr64, zb_event_e event_ * * @since_tizen 4.0 * - * @remarks You must free all resources of the zigbee by calling zb_destroy() - * if zigbee service is no longer needed. - * * @param[in] handle The handle of zigbee * @param[in] event_handler The event handler * @@ -212,9 +203,6 @@ typedef void (*zb_disable_network_cb)(unsigned char status, void *user_data); * @privlevel public * @privilege %http://tizen.org/privilege/zigbee * - * @remarks You must destroy all device and routing information before calling this - * function. - * * @param[in] handle The handle of zigbee * @param[in] cb zb_disable_network_cb * @param[in] user_data user data