From 50978d699534fb45b04cc7c674d4196f006ea9a3 Mon Sep 17 00:00:00 2001 From: Jiwan Kim Date: Tue, 21 Mar 2017 17:11:26 +0900 Subject: [PATCH] Fix typos & ACR issues - Fix typos on doxygen - Change doxygen @param[out] -> [in] for callbacks Change-Id: I7a538dfcd14e87819f9e5ec507120c158a0eaab5 Signed-off-by: Jiwan Kim --- include/zb_custom.h | 38 ++++---- include/zb_ha.h | 8 +- include/zb_type.h | 2 +- include/zb_zcl.h | 34 ++++---- include/zb_zdo.h | 30 +++---- include/zcl/zb_zcl_alarm_cluster.h | 14 +-- include/zcl/zb_zcl_attribute_ids.h | 62 +++++++------- include/zcl/zb_zcl_attribute_type.h | 6 +- include/zcl/zb_zcl_global_commands.h | 52 +++++------ include/zcl/zb_zcl_groups_cluster.h | 44 +++++----- include/zcl/zb_zcl_identify_cluster.h | 6 +- include/zcl/zb_zcl_poll_control_cluster.h | 6 +- include/zcl/zb_zcl_scenes_cluster.h | 84 +++++++++--------- include/zcl/zb_zcl_type.h | 2 +- include/zdo/zb_zdo_bind_mgr.h | 8 +- include/zdo/zb_zdo_dev_disc.h | 100 +++++++++++----------- include/zdo/zb_zdo_nwk_mgr.h | 74 ++++++++-------- include/zdo/zb_zdo_svc_disc.h | 42 ++++----- include/zigbee.h | 26 +++--- 19 files changed, 319 insertions(+), 319 deletions(-) diff --git a/include/zb_custom.h b/include/zb_custom.h index df0ff47..402e999 100644 --- a/include/zb_custom.h +++ b/include/zb_custom.h @@ -40,14 +40,14 @@ * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] src_ep source end-point (ex. 1) - * @param[out] dst_ep destination end-point (ex. 1) - * @param[out] cluster_id ZCL cluster id - * @param[out] profile_id Profile id - * @param[out] payload_len Length of payload - * @param[out] payload Payload data - * @param[out] user_data User data + * @param[in] addr16 Network address + * @param[in] src_ep source end-point (ex. 1) + * @param[in] dst_ep destination end-point (ex. 1) + * @param[in] cluster_id ZCL cluster id + * @param[in] profile_id Profile id + * @param[in] payload_len Length of payload + * @param[in] payload Payload data + * @param[in] user_data User data * * @see zb_aps_send() */ @@ -66,14 +66,14 @@ typedef void (*zb_aps_send_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] src_ep source end-point (ex. 1) - * @param[out] dst_ep destination end-point (ex. 1) - * @param[out] cluster_id ZCL cluster id - * @param[out] profile_id Profile id - * @param[out] payload_len Length of payload - * @param[out] payload Payload data - * @param[out] user_data User data + * @param[in] addr16 Network address + * @param[in] src_ep source end-point (ex. 1) + * @param[in] dst_ep destination end-point (ex. 1) + * @param[in] cluster_id ZCL cluster id + * @param[in] profile_id Profile id + * @param[in] payload_len Length of payload + * @param[in] payload Payload data + * @param[in] user_data User data * * @see zb_zcl_send() */ @@ -92,9 +92,9 @@ typedef void (*zb_zcl_send_rsp)( * * @since_tizen 4.0 * - * @param[out] length The length of data - * @param[out] data Received data - * @param[out] user_data User data + * @param[in] length The length of data + * @param[in] data Received data + * @param[in] user_data User data * * @see zb_send_to_local() */ diff --git a/include/zb_ha.h b/include/zb_ha.h index 9a4924e..06335d0 100644 --- a/include/zb_ha.h +++ b/include/zb_ha.h @@ -40,12 +40,12 @@ typedef enum { ZB_HA_CONFIGURATION_TOOL = 0x0005, /**< Configuration tool device */ ZB_HA_REMOTE_CONTROL = 0x0006, /**< Remote control device */ ZB_HA_COMBINED_INTERFACE = 0x0007, /**< Combined interface device */ - ZB_HA_RANGE_EXTENDER = 0x0008, /**< Range exntender device */ + ZB_HA_RANGE_EXTENDER = 0x0008, /**< Range extender device */ ZB_HA_MAINS_POWER_OUTLET = 0x0009, /**< Main power outlet device */ ZB_HA_DOOR_LOCK = 0x000A, /**< Door lock device */ ZB_HA_DOOR_LOCK_CONTROLLER = 0x000B, /**< Door lock controller device */ ZB_HA_SIMPLE_SENSOR = 0x000C, /**< Simple sensor device */ - ZB_HA_CONSUMPTION_AWARENESS_DEVICE = 0x000D, /**< Comsumption awareness device */ + ZB_HA_CONSUMPTION_AWARENESS_DEVICE = 0x000D, /**< Consumption awareness device */ ZB_HA_HOME_GATEWAY = 0x0050, /**< Home gateway device */ ZB_HA_SMART_PLUG = 0x0051, /**< Smart plug device */ ZB_HA_WHITE_GOODS = 0x0052, /**< White goods device */ @@ -74,8 +74,8 @@ typedef enum { ZB_HA_FLOW_SENSOR = 0x0306, /**< Flow sensor device */ ZB_HA_MINI_SPLIT_AC = 0x0307, /**< Mini split device */ /* Intruder Alarms system */ - ZB_HA_ISA_CONTROL_AND_INDICATING_EQUIPMENT = 0x0400, /**< ISA control and indicatiing equipment device */ - ZB_HA_ISA_ANCILLARY_CONTROL_EQUIPMENT = 0x0401, /**< ISA ancillary controll device */ + ZB_HA_ISA_CONTROL_AND_INDICATING_EQUIPMENT = 0x0400, /**< ISA control and indicating equipment device */ + ZB_HA_ISA_ANCILLARY_CONTROL_EQUIPMENT = 0x0401, /**< ISA ancillary control device */ ZB_HA_ISA_ZONE = 0x0402, /**< ISA zone device */ ZB_HA_ISA_WARNIGN_DEVICE = 0x0403, /**< ISA warning device */ } ha_device_id_e; diff --git a/include/zb_type.h b/include/zb_type.h index c474843..7f74a61 100644 --- a/include/zb_type.h +++ b/include/zb_type.h @@ -88,7 +88,7 @@ typedef enum { ZB_ZCL_IAS_ZONE_ENROLL_REQUEST_EVENT = 0x21, /**< A Device which supports IAS zone cluster want to register its ability */ ZB_ZCL_IAS_ZONE_STATUS_CHANGE_NOTIFICATION_EVENT = 0x22, /**< A Device which supports IAS zone cluster notifies its status change */ ZB_ZCL_IAS_ZONE_STATUS_CHANGE_EXTENDED_NOTIFICATION_EVENT = 0x23, /**< A Device which supports IAS zone cluster notifies its status change */ - ZB_ZCL_LEVEL_CONTROL_CURRENT_LEVEL_ATTRIBUTE_REPORT_EVENT = 0x30, /**< (Confusint) This event will be received after level control cluster attribute changed */ + ZB_ZCL_LEVEL_CONTROL_CURRENT_LEVEL_ATTRIBUTE_REPORT_EVENT = 0x30, /**< This event will be received after level control cluster attribute changed */ ZB_ZCL_COLOR_CONTROL_CURRENT_X_ATTRIBUTE_REPORT_EVENT = 0x31, /**< This event will be received after color control cluster X attribute changed */ ZB_ZCL_COLOR_CONTROL_CURRENT_Y_ATTRIBUTE_REPORT_EVENT = 0x32, /**< This event will be received after color control cluster Y attribute changed */ ZB_ZCL_COLOR_CONTROL_CURRENT_HUE_ATTRIBUTE_REPORT_EVENT = 0x33, /**< This event will be received after color control cluster hue attribute changed */ diff --git a/include/zb_zcl.h b/include/zb_zcl.h index c661ff1..7fa4aac 100644 --- a/include/zb_zcl.h +++ b/include/zb_zcl.h @@ -53,7 +53,7 @@ #include /** - * @brief Returns readabble Zigbee Cluster Library status code for human + * @brief Returns readable Zigbee Cluster Library status code for human * @details Returns Zigbee Cluster Library status code * * @since_tizen 4.0 @@ -501,12 +501,12 @@ int zb_set_value_to_read_attr_status_record( zb_value_h value); /** - * @brief Creates discover attribute infomation record - * @details This allocates heap for discover attribute infomation record + * @brief Creates discover attribute information record + * @details This allocates heap for discover attribute information record * * @since_tizen 4.0 * - * @param[in] handle handle of discover attribute infomation record + * @param[out] handle handle of discover attribute information record * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -520,12 +520,12 @@ int zb_set_value_to_read_attr_status_record( int zb_create_discover_attr_info(discover_attr_info_record_h *handle); /** - * @brief Destroys discover attribute infomation record - * @details This destroys discover attribute infomation record + * @brief Destroys discover attribute information record + * @details This destroys discover attribute information record * * @since_tizen 4.0 * - * @param[in] handle handle of discover attribute infomation record + * @param[in] handle handle of discover attribute information record * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -796,7 +796,7 @@ int zb_set_value_to_write_attr_record( * * @since_tizen 4.0 * - * @param[in] handle handle of write attribute status record + * @param[out] handle handle of write attribute status record * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -833,7 +833,7 @@ void zb_destroy_write_attr_status(write_attr_status_record_h handle); * @brief Gets status from write attribute status record * @details The status field is 8 bits in length and specifies the status of the read * operation on this attribute. \n\n This field shall be set to SUCCESS, if the operation - * was successful, or an error code, as specifed in zb_zcl_status_e if the operation was + * was successful, or an error code, as specified in zb_zcl_status_e if the operation was * not successful. * * @since_tizen 4.0 @@ -856,7 +856,7 @@ int zb_get_status_from_write_attr_status( * @brief Sets status to write attribute status record * @details The status field is 8 bits in length and specifies the status of the read * operation on this attribute. \n\n This field shall be set to SUCCESS, if the operation - * was successful, or an error code, as specifed in zb_zcl_status_e if the operation was + * was successful, or an error code, as specified in zb_zcl_status_e if the operation was * not successful. * * @since_tizen 4.0 @@ -935,7 +935,7 @@ int zb_set_id_to_write_attr_status( * * @since_tizen 4.0 * - * @param[in] handle handle of reporting configuration record + * @param[out] handle handle of reporting configuration record * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -1831,7 +1831,7 @@ int zb_get_change_from_report_config_record3( * * @since_tizen 4.0 * - * @param[in] handle handle of read configuration record + * @param[out] handle handle of read configuration record * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -1921,7 +1921,7 @@ int zb_set_dir_to_read_report_config_record( unsigned char dir); /** - * @brief Gets attribute idenitifier from read reporting configuration record + * @brief Gets attribute identifier from read reporting configuration record * @details The attribute identifier field shall contain the identifier of the attribute * whose reporting configuration details are to be read. * @@ -1946,7 +1946,7 @@ int zb_get_id_from_read_report_config_record( unsigned short *id); /** - * @brief Gets attribute idenitifier from read reporting configuration record + * @brief Gets attribute identifier from read reporting configuration record * @details The attribute identifier field shall contain the identifier of the attribute * whose reporting configuration details are to be read. * @@ -1976,7 +1976,7 @@ int zb_set_id_to_read_report_config_record( * * @since_tizen 4.0 * - * @param[in] handle handle of reporting configuration response record + * @param[out] handle handle of reporting configuration response record * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -2221,7 +2221,7 @@ int zb_set_id_to_report_config_response_record( * * @since_tizen 4.0 * - * @param[in] handle handle of reporting attribute + * @param[out] handle handle of reporting attribute * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -2446,7 +2446,7 @@ int zb_set_value_to_attr_report( * * @since_tizen 4.0 * - * @param[in] handle handle of extended attribute information + * @param[out] handle handle of extended attribute information * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful diff --git a/include/zb_zdo.h b/include/zb_zdo.h index 74963d3..b1ff459 100644 --- a/include/zb_zdo.h +++ b/include/zb_zdo.h @@ -43,7 +43,7 @@ #include /** - * @brief Return readabble ZDO error code + * @brief Return readable ZDO error code * @details Return ZDO error code string * * @since_tizen 4.0 @@ -56,7 +56,7 @@ const char* zb_zdo_get_error_message(int id); /** - * @brief Return readabble Zigbee profile id + * @brief Return readable Zigbee profile id * @details Return Zigbee profile id * * @since_tizen 4.0 @@ -69,7 +69,7 @@ const char* zb_zdo_get_error_message(int id); const char* zb_get_profile_id_string(int profile_id); /** - * @brief Return readabble Zigbee device id + * @brief Return readable Zigbee device id * @details Return Zigbee device id * * @since_tizen 4.0 @@ -107,7 +107,7 @@ int zb_simple_desc_create( * @since_tizen 4.0 * * @param[in] src handle of source simple descriptor - * @param[out] dst handle of destination simple descriptor + * @param[in] dst handle of destination simple descriptor * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -472,7 +472,7 @@ int zb_node_power_desc_create( * @since_tizen 4.0 * * @param[in] src handle of source node power descriptor - * @param[out] dst handle of destination node power descriptor + * @param[in] dst handle of destination node power descriptor * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -615,7 +615,7 @@ int zb_node_power_desc_set_available_power_sources( * @since_tizen 4.0 * * @param[in] handle handle of node power descriptor - * @param[in] current_power_source 0b0001 : Constant (mains) power \n + * @param[out] current_power_source 0b0001 : Constant (mains) power \n * 0b0010 : Rechargeable battery \n * 0b0100 : Disposable battery \n * @@ -663,7 +663,7 @@ int zb_node_power_desc_set_current_power_source( * @since_tizen 4.0 * * @param[in] handle handle of node power descriptor - * @param[in] current_power_source_level 0b0000 : Citical \n + * @param[out] current_power_source_level 0b0000 : Critical \n * 0b0100 : 33% \n * 0b1000 : 66% \n * 0b1100 : 100% \n @@ -708,7 +708,7 @@ int zb_node_power_desc_set_current_power_source_level( * * @since_tizen 4.0 * - * @param[in] handle handle of node descriptor + * @param[out] handle handle of node descriptor * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -769,8 +769,8 @@ int zb_node_desc_destroy( * * @param[in] handle handle of node descriptor * @param[out] logical_type 0b000 : ZigBee coordinator \n - * 0b001 : Zigbee router \n - * 0b010 : Zigee end device \n + * 0b001 : ZigBee router \n + * 0b010 : ZigBee end device \n * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -863,7 +863,7 @@ int zb_node_desc_set_complex_descriptor_available( * @since_tizen 4.0 * * @param[in] handle handle of node descriptor - * @param[in] user_descriptor_available 1 : a user descriptor is available \n + * @param[out] user_descriptor_available 1 : a user descriptor is available \n * 0 : a user descriptor is not available \n * * @return 0 on success, otherwise a negative error value. @@ -1026,7 +1026,7 @@ int zb_node_desc_set_frequency_band( * @since_tizen 4.0 * * @param[in] handle handle of node descriptor - * @param[in] mac_capability_flags Bit 0 : Alternative PAN coordinator \n + * @param[out] mac_capability_flags Bit 0 : Alternative PAN coordinator \n * Bit 1 : Device Type \n * Bit 2 : Power source \n * Bit 3 : Receiver on when idle \n @@ -1075,7 +1075,7 @@ int zb_node_desc_get_mac_capability_flags( * @since_tizen 4.0 * * @param[in] handle handle of node descriptor - * @param[out] mac_capability_flags Bit 0 : Alternative PAN coordinator \n + * @param[in] mac_capability_flags Bit 0 : Alternative PAN coordinator \n * Bit 1 : Device Type \n * Bit 2 : Power source \n * Bit 3 : Receiver on when idle \n @@ -1171,7 +1171,7 @@ int zb_node_desc_get_maximum_buffer_size( * @since_tizen 4.0 * * @param[in] handle handle of node descriptor - * @param[out] maximum_buffer_size 0x00~0x7f + * @param[in] maximum_buffer_size 0x00~0x7f * * @return 0 on success, otherwise a negative error value. * @retval #ZIGBEE_ERROR_NONE Successful @@ -1880,7 +1880,7 @@ int zb_neighbor_table_desc_get_rx_on_when_idle( * @since_tizen 4.0 * * @param[in] handle handle of node descriptor - * @param[out] releationship The relationship between the + * @param[out] relationship The relationship between the * neighbor and the current device: \n * 0x0 = neighbor is the parent \n * 0x1 = neighbor is a child \n diff --git a/include/zcl/zb_zcl_alarm_cluster.h b/include/zcl/zb_zcl_alarm_cluster.h index 949277d..e91f9cb 100644 --- a/include/zcl/zb_zcl_alarm_cluster.h +++ b/include/zcl/zb_zcl_alarm_cluster.h @@ -58,18 +58,18 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Destination endpoint - * @param[out] status Status code \n + * @param[in] addr16 Network address + * @param[in] ep Destination endpoint + * @param[in] status Status code \n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_NOT_FOUND - * @param[out] alarm_code Alarm code (8bit enumeration) + * @param[in] alarm_code Alarm code (8bit enumeration) * @ Identifying code for the cause of the alarm, * @ as given in the specification of the cluster * @ whose attribute generated this alarm. - * @param[out] cluster_id Custer identifier - * @param[out] time_stamp Unsigned 32bit time stamp - * @param[out] user_data User data + * @param[in] cluster_id Custer identifier + * @param[in] time_stamp Unsigned 32bit time stamp + * @param[in] user_data User data * * @see zb_zcl_alarm_get_alarm() */ diff --git a/include/zcl/zb_zcl_attribute_ids.h b/include/zcl/zb_zcl_attribute_ids.h index 7daed48..5f34443 100644 --- a/include/zcl/zb_zcl_attribute_ids.h +++ b/include/zcl/zb_zcl_attribute_ids.h @@ -47,7 +47,7 @@ typedef enum { ZB_ZCL_STACK_VERSION_ATTRIBUTE_ID = 0x0002, /**< Stack version */ ZB_ZCL_HW_VERSION_ATTRIBUTE_ID = 0x0003, /**< HW version */ ZB_ZCL_MANUFACTURER_NAME_ATTRIBUTE_ID = 0x0004, /**< Manufacturer name */ - ZB_ZCL_MODEL_IDENTIFIER_ATTRIBUTE_ID = 0x0005, /**< Model identifer */ + ZB_ZCL_MODEL_IDENTIFIER_ATTRIBUTE_ID = 0x0005, /**< Model identifier */ ZB_ZCL_DATE_CODE_ATTRIBUTE_ID = 0x0006, /**< Date code */ ZB_ZCL_POWER_SOURCE_ATTRIBUTE_ID = 0x0007, /**< Power source */ ZB_ZCL_APPLICATION_PROFILE_VERSION_ATTRIBUTE_ID = 0x0008, /**< Application profile version */ @@ -97,8 +97,8 @@ typedef enum { ZB_ZCL_BATTERY_2_AHR_RATING_ATTRIBUTE_ID = 0x0052, /**< Battery 2 Ampere/Hr rating (since ha-1.2-05-3520-29 */ ZB_ZCL_BATTERY_2_QUANTITY_ATTRIBUTE_ID = 0x0053, /**< Battery 2 quantity (since ha-1.2-05-3520-29 */ ZB_ZCL_BATTERY_2_RATED_VOLTAGE_ATTRIBUTE_ID = 0x0054, /**< Battery 2 rated voltage (since ha-1.2-05-3520-29 */ - ZB_ZCL_BATTERY_2_ALARM_MASK_ATTRIBUTE_ID = 0x0055, /**< Batery 2 alarm mask (since ha-1.2-05-3520-29 */ - ZB_ZCL_BATTERY_2_VOLTAGE_MIN_THRESHOLD_ATTRIBUTE_ID = 0x0056, /**< Batery 2 voltage min. threshold (since ha-1.2-05-3520-29 */ + ZB_ZCL_BATTERY_2_ALARM_MASK_ATTRIBUTE_ID = 0x0055, /**< Battery 2 alarm mask (since ha-1.2-05-3520-29 */ + ZB_ZCL_BATTERY_2_VOLTAGE_MIN_THRESHOLD_ATTRIBUTE_ID = 0x0056, /**< Battery 2 voltage min. threshold (since ha-1.2-05-3520-29 */ ZB_ZCL_BATTERY_2_VOLTAGE_THRESHOLD_1_ATTRIBUTE_ID = 0x0057, /**< Battery 2 voltage threshold 1 (since ha-1.2-05-3520-29 */ ZB_ZCL_BATTERY_2_VOLTAGE_THRESHOLD_2_ATTRIBUTE_ID = 0x0058, /**< Battery 2 voltage threshold 2 (since ha-1.2-05-3520-29 */ ZB_ZCL_BATTERY_2_VOLTAGE_THRESHOLD_3_ATTRIBUTE_ID = 0x0059, /**< Battery 2 voltage threshold 3 (since ha-1.2-05-3520-29 */ @@ -153,8 +153,8 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_IDENTIFY_TIME_ATTRIBUTE_ID = 0x0000, /**< Identiy time */ - ZB_ZCL_COMMISSION_STATE_ATTRIBUTE_ID = 0x0001, /**< Commision state */ + ZB_ZCL_IDENTIFY_TIME_ATTRIBUTE_ID = 0x0000, /**< Identity time */ + ZB_ZCL_COMMISSION_STATE_ATTRIBUTE_ID = 0x0001, /**< Commission state */ } zb_zcl_identify_server_attributes_e; /** @@ -182,7 +182,7 @@ typedef enum { ZB_ZCL_CURRENT_GROUP_ATTRIBUTE_ID = 0x0002, /**< Current group */ ZB_ZCL_SCENE_VALID_ATTRIBUTE_ID = 0x0003, /**< Scene valid */ ZB_ZCL_SCENE_NAME_SUPPORT_ATTRIBUTE_ID = 0x0004, /**< Scene name support */ - ZB_ZCL_LAST_CONFIGURED_BY_ATTRIBUTE_ID = 0x0005, /**< Last congigured by */ + ZB_ZCL_LAST_CONFIGURED_BY_ATTRIBUTE_ID = 0x0005, /**< Last configured by */ } zb_zcl_scenes_server_attributes_e; /** @@ -279,7 +279,7 @@ typedef enum { ZB_ZCL_POWER_ATTRIBUTE_ID = 0x0013, /**< Power */ ZB_ZCL_PATH_LOSS_EXPONENT_ATTRIBUTE_ID = 0x0014, /**< Path loss exponent */ ZB_ZCL_REPORTING_PERIOD_ATTRIBUTE_ID = 0x0015, /**< Reporting period */ - ZB_ZCL_CALCULATION_PERIOD_ATTRIBUTE_ID = 0x0016, /**< Calculatoin period */ + ZB_ZCL_CALCULATION_PERIOD_ATTRIBUTE_ID = 0x0016, /**< Calculation period */ ZB_ZCL_NUMBER_RSSI_MEASUREMENTS_ATTRIBUTE_ID = 0x0017, /**< Number RSSI measurements */ } zb_zcl_rssi_location_server_attributes_e; @@ -299,7 +299,7 @@ typedef enum { ZB_ZCL_PRESENT_VALUE_ATTRIBUTE_ID = 0x0055, /**< Present value */ ZB_ZCL_RELIABILITY_ATTRIBUTE_ID = 0x0067, /**< Reliability */ ZB_ZCL_STATUS_FLAGS_ATTRIBUTE_ID = 0x006F, /**< Status flag */ - ZB_ZCL_APPLICATION_TYPE_ATTRIBUTE_ID = 0x0100, /**< Applicatoin type */ + ZB_ZCL_APPLICATION_TYPE_ATTRIBUTE_ID = 0x0100, /**< Application type */ } zb_zcl_binary_input_basic_server_attributes_e; /** @@ -344,7 +344,7 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_PARTITION_MAXIMUM_INCOMING_TRANSFER_SIZE_ATTRIBUTE_ID = 0x0000, /**< Partition maximum incomming transfer size */ + ZB_ZCL_PARTITION_MAXIMUM_INCOMING_TRANSFER_SIZE_ATTRIBUTE_ID = 0x0000, /**< Partition maximum incoming transfer size */ ZB_ZCL_PARTITION_MAXIMUM_OUTGOING_TRANSFER_SIZE_ATTRIBUTE_ID = 0x0001, /**< Partition maximum outgoing transfer size */ ZB_ZCL_PARTIONED_FRAME_SIZE_ATTRIBUTE_ID = 0x0002, /**< Partioned frame size */ ZB_ZCL_LARGE_FRAME_SIZE_ATTRIBUTE_ID = 0x0003, /**< Large frame size */ @@ -385,10 +385,10 @@ typedef enum { * @since_tizen 4.0 */ typedef enum { - ZB_ZCL_TOTAL_PROFILE_NUM_ATTRIBUTE_ID = 0x0000, /**< Totgal profile number */ + ZB_ZCL_TOTAL_PROFILE_NUM_ATTRIBUTE_ID = 0x0000, /**< Total profile number */ ZB_ZCL_MULTIPLE_SCHEDULING_ATTRIBUTE_ID = 0x0001, /**< Multiple scheduling */ ZB_ZCL_ENERGY_FORMATTING_ATTRIBUTE_ID = 0x0002, /**< Energy formatting */ - ZB_ZCL_ENERGY_REMOTE_ATTRIBUTE_ID = 0x0003, /**< Enegery remote */ + ZB_ZCL_ENERGY_REMOTE_ATTRIBUTE_ID = 0x0003, /**< Energy remote */ ZB_ZCL_SCHEDULE_MODE_ATTRIBUTE_ID = 0x0004, /**< Schedule mode */ } zb_zcl_power_profile_server_attributes_e; @@ -454,7 +454,7 @@ typedef enum { ZB_ZCL_OPEN_PERIOD_ATTRIBUTE_ID = 0x0006, /**< Open period */ ZB_ZCL_NUM_LOCK_RECORDS_SUPPORTED_ATTRIBUTE_ID = 0x0010, /**< Number of lock records supported (since ha-1.2-05-3520-29) */ ZB_ZCL_NUM_TOTAL_USERS_SUPPORTED_ATTRIBUTE_ID = 0x0011, /**< Number of total users supported (since ha-1.2-05-3520-29) */ - ZB_ZCL_NUM_PIN_USERS_SUPPORTED_ATTRIBUTE_ID = 0x0012, /**< Number of PIN users supproted (since ha-1.2-05-3520-29) */ + ZB_ZCL_NUM_PIN_USERS_SUPPORTED_ATTRIBUTE_ID = 0x0012, /**< Number of PIN users supported (since ha-1.2-05-3520-29) */ ZB_ZCL_NUM_RFID_USERS_SUPPORTED_ATTRIBUTE_ID = 0x0013, /**< Number of RFID users supported (since ha-1.2-05-3520-29) */ ZB_ZCL_NUM_WEEKDAY_SCHEDULES_SUPPORTED_PER_USER_ATTRIBUTE_ID = 0x0014, /**< Number of weekday schedules supported per user (since ha-1.2-05-3520-29) */ ZB_ZCL_NUM_YEARDAY_SCHEDULES_SUPPORTED_PER_USER_ATTRIBUTE_ID = 0x0015, /**< Number of yearday schedules supported per user (since ha-1.2-05-3520-29) */ @@ -470,7 +470,7 @@ typedef enum { ZB_ZCL_SOUND_VOLUME_ATTRIBUTE_ID = 0x0024, /**< Sound volume (since ha-1.2-05-3520-29) */ ZB_ZCL_OPERATING_MODE_ATTRIBUTE_ID = 0x0025, /**< Operating mode (since ha-1.2-05-3520-29) */ ZB_ZCL_SUPPORTED_OPERATING_MODES_ATTRIBUTE_ID = 0x0026, /**< Supported operating modes (since ha-1.2-05-3520-29) */ - ZB_ZCL_DEFAULT_CONFIGURATION_REGISTER_ATTRIBUTE_ID = 0x0027, /**< Default configuratoin registger (since ha-1.2-05-3520-29) */ + ZB_ZCL_DEFAULT_CONFIGURATION_REGISTER_ATTRIBUTE_ID = 0x0027, /**< Default configuration register (since ha-1.2-05-3520-29) */ ZB_ZCL_ENABLE_LOCAL_PROGRAMMING_ATTRIBUTE_ID = 0x0028, /**< Enable local programming (since ha-1.2-05-3520-29) */ ZB_ZCL_ENABLE_ONE_TOUCH_LOCKING_ATTRIBUTE_ID = 0x0029, /**< Enable one touch locking (since ha-1.2-05-3520-29) */ ZB_ZCL_ENABLE_INSIDE_STATUS_LED_ATTRIBUTE_ID = 0x002A, /**< Enable inside status LED (since ha-1.2-05-3520-29) */ @@ -487,7 +487,7 @@ typedef enum { ZB_ZCL_RFID_OPERATION_EVENT_MASK_ATTRIBUTE_ID = 0x0044, /**< RFID operation event mask (since ha-1.2-05-3520-29) */ ZB_ZCL_KEYPAD_PROGRAMMING_EVENT_MASK_ATTRIBUTE_ID = 0x0045, /**< Keypad programming event mask (since ha-1.2-05-3520-29) */ ZB_ZCL_RF_PROGRAMMING_EVENT_MASK_ATTRIBUTE_ID = 0x0046, /**< RF programming event mask (since ha-1.2-05-3520-29) */ - ZB_ZCL_RFID_PROGRAMMING_EVENT_MASK_ATTRIBUTE_ID = 0x0047, /**< RFID pgramming event mask (since ha-1.2-05-3520-29) */ + ZB_ZCL_RFID_PROGRAMMING_EVENT_MASK_ATTRIBUTE_ID = 0x0047, /**< RFID programming event mask (since ha-1.2-05-3520-29) */ } zb_zcl_door_lock_server_attributes_e; /** @@ -546,9 +546,9 @@ typedef enum { ZB_ZCL_EFFECTIVE_CONTROL_MODE_ATTRIBUTE_ID = 0x0012, /**< Effective control mode */ ZB_ZCL_CAPACITY_ATTRIBUTE_ID = 0x0013, /**< Capacity */ ZB_ZCL_SPEED_ATTRIBUTE_ID = 0x0014, /**< Speed */ - ZB_ZCL_LIFETIME_RUNNING_HOURS_ATTRIBUTE_ID = 0x0015, /**< Lifetime runnging hours */ + ZB_ZCL_LIFETIME_RUNNING_HOURS_ATTRIBUTE_ID = 0x0015, /**< Lifetime running hours */ ZB_ZCL_PUMP_POWER_ATTRIBUTE_ID = 0x0016, /**< Pump power */ - ZB_ZCL_LIFETIME_ENERGY_CONSUMED_ATTRIBUTE_ID = 0x0017, /**< Lifetime enerfy consumed */ + ZB_ZCL_LIFETIME_ENERGY_CONSUMED_ATTRIBUTE_ID = 0x0017, /**< Lifetime energy consumed */ ZB_ZCL_OPERATION_MODE_ATTRIBUTE_ID = 0x0020, /**< Operation mode */ ZB_ZCL_CONTROL_MODE_ATTRIBUTE_ID = 0x0021, /**< Control mode */ ZB_ZCL_PUMP_ALARM_MASK_ATTRIBUTE_ID = 0x0022, /**< Pump alarm mask */ @@ -602,9 +602,9 @@ typedef enum { ZB_ZCL_AC_REFRIGERANT_TYPE_ATTRIBUTE_ID = 0x0042, /**< AC refrigerant type (since ha-1.2-05-3520-29) */ ZB_ZCL_AC_COMPRESSOR_ATTRIBUTE_ID = 0x0043, /**< AC compressor (since ha-1.2-05-3520-29) */ ZB_ZCL_AC_ERROR_CODE_ATTRIBUTE_ID = 0x0044, /**< AC error mode (since ha-1.2-05-3520-29) */ - ZB_ZCL_AC_LOUVER_POSITION_ATTRIBUTE_ID = 0x0045, /**< AC lovver position (since ha-1.2-05-3520-29) */ - ZB_ZCL_AC_COIL_TEMPERATURE_ATTRIBUTE_ID = 0x0046, /**< AC coli temperature (since ha-1.2-05-3520-29) */ - ZB_ZCL_AC_CAPACITY_FORMAT_ATTRIBUTE_ID = 0x0047, /**< AC capacity foramt (since ha-1.2-05-3520-29) */ + ZB_ZCL_AC_LOUVER_POSITION_ATTRIBUTE_ID = 0x0045, /**< AC louver position (since ha-1.2-05-3520-29) */ + ZB_ZCL_AC_COIL_TEMPERATURE_ATTRIBUTE_ID = 0x0046, /**< AC coil temperature (since ha-1.2-05-3520-29) */ + ZB_ZCL_AC_CAPACITY_FORMAT_ATTRIBUTE_ID = 0x0047, /**< AC capacity format (since ha-1.2-05-3520-29) */ } zb_zcl_thermostat_server_attributes_e; /** @@ -628,7 +628,7 @@ typedef enum { */ typedef enum { ZB_ZCL_RELATIVE_HUMIDITY_ATTRIBUTE_ID = 0x0000, /**< Relative humidity */ - ZB_ZCL_DEHUMIDIFICATION_COOLING_ATTRIBUTE_ID = 0x0001, /**< Dehumidication cooling */ + ZB_ZCL_DEHUMIDIFICATION_COOLING_ATTRIBUTE_ID = 0x0001, /**< Dehumidification cooling */ ZB_ZCL_RH_DEHUMIDIFICATION_SETPOINT_ATTRIBUTE_ID = 0x0010, /**< RH dehumidification setpoint */ ZB_ZCL_RELATIVE_HUMIDITY_MODE_ATTRIBUTE_ID = 0x0011, /**< Relative humidity mode */ ZB_ZCL_DEHUMIDIFICATION_LOCKOUT_ATTRIBUTE_ID = 0x0012, /**< Dehumidification lockout */ @@ -856,7 +856,7 @@ typedef enum { ZB_ZCL_IAS_CIE_ADDRESS_ATTRIBUTE_ID = 0x0010, /**< IAS CIE address */ ZB_ZCL_ZONE_ID_ATTRIBUTE_ID = 0x0011, /**< Zone ID */ ZB_ZCL_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED_ATTRIBUTE_ID = 0x0012, /**< Number of zone sensitivity levels supported */ - ZB_ZCL_CURRENT_ZONE_SENSITIVITY_LEVEL_ATTRIBUTE_ID = 0x0013, /**< Current zone sensitivitiy level */ + ZB_ZCL_CURRENT_ZONE_SENSITIVITY_LEVEL_ATTRIBUTE_ID = 0x0013, /**< Current zone sensitivity level */ } zb_zcl_isa_zone_server_server_attributes_e; /** @@ -891,7 +891,7 @@ typedef enum { ZB_ZCL_DC_VOLTAGE_MULTIPLIER_ATTRIBUTE_ID = 0x0200, /**< DC voltage multiplier */ ZB_ZCL_DC_VOLTAGE_DIVISOR_ATTRIBUTE_ID = 0x0201, /**< DC voltage divisor */ ZB_ZCL_DC_CURRENT_MULTIPLIER_ATTRIBUTE_ID = 0x0202, /**< DC current multiplier */ - ZB_ZCL_DC_CURRENT_DIVISOR_ATTRIBUTE_ID = 0x0203, /**< DC current divisior */ + ZB_ZCL_DC_CURRENT_DIVISOR_ATTRIBUTE_ID = 0x0203, /**< DC current divisor */ ZB_ZCL_DC_POWER_MULTIPLIER_ATTRIBUTE_ID = 0x0204, /**< DC power multiplier */ ZB_ZCL_DC_POWER_DIVISOR_ATTRIBUTE_ID = 0x0205, /**< DC power divisor */ ZB_ZCL_AC_FREQUENCY_ATTRIBUTE_ID = 0x0300, /**< AC frequency */ @@ -934,12 +934,12 @@ typedef enum { ZB_ZCL_ACTIVE_POWER_MIN_ATTRIBUTE_ID = 0x050C, /**< Active power min. */ ZB_ZCL_ACTIVE_POWER_MAX_ATTRIBUTE_ID = 0x050D, /**< Active power max. */ ZB_ZCL_REACTIVE_POWER_ATTRIBUTE_ID = 0x050E, /**< Reactive power */ - ZB_ZCL_APPARENT_POWER_ATTRIBUTE_ID = 0x050F, /**< Apprent power */ + ZB_ZCL_APPARENT_POWER_ATTRIBUTE_ID = 0x050F, /**< Apparent power */ ZB_ZCL_AC_POWER_FACTOR_ATTRIBUTE_ID = 0x0510, /**< AC power factor */ ZB_ZCL_AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_ATTRIBUTE_ID = 0x0511, /**< Average RMS voltage measurement period */ ZB_ZCL_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_ATTRIBUTE_ID = 0x0513, /**< Average RMS under voltage counter */ - ZB_ZCL_RMS_EXTREME_OVER_VOLTAGE_PERIOD_ATTRIBUTE_ID = 0x0514, /**< RMS extrem over voltage period */ - ZB_ZCL_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_ATTRIBUTE_ID = 0x0515, /**< RMS extrem under voltage period */ + ZB_ZCL_RMS_EXTREME_OVER_VOLTAGE_PERIOD_ATTRIBUTE_ID = 0x0514, /**< RMS extreme over voltage period */ + ZB_ZCL_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_ATTRIBUTE_ID = 0x0515, /**< RMS extreme under voltage period */ ZB_ZCL_RMS_VOLTAGE_SAG_PERIOD_ATTRIBUTE_ID = 0x0516, /**< RMS voltage sag period */ ZB_ZCL_RMS_VOLTAGE_SWELL_PERIOD_ATTRIBUTE_ID = 0x0517, /**< RMS voltage swell period */ ZB_ZCL_AC_VOLTAGE_MULTIPLIER_ATTRIBUTE_ID = 0x0600, /**< AC voltage multiplier */ @@ -975,11 +975,11 @@ typedef enum { ZB_ZCL_ACTIVE_POWER_MIN_PHASE_B_ATTRIBUTE_ID = 0x090C, /**< Active power min. phase B */ ZB_ZCL_ACTIVE_POWER_MAX_PHASE_B_ATTRIBUTE_ID = 0x090D, /**< Active power max. B */ ZB_ZCL_REACTIVE_POWER_PHASE_B_ATTRIBUTE_ID = 0x090E, /**< Reactive power phase B */ - ZB_ZCL_APPARENT_POWER_PHASE_B_ATTRIBUTE_ID = 0x090F, /**< Apprent power phase B */ + ZB_ZCL_APPARENT_POWER_PHASE_B_ATTRIBUTE_ID = 0x090F, /**< Apparent power phase B */ ZB_ZCL_POWER_FACTOR_PHASE_B_ATTRIBUTE_ID = 0x0910, /**< Power factor phase B */ ZB_ZCL_AVERAGE_RMS_VOLTAGE_MEASUREMENT_PERIOD_PHASE_B_ATTRIBUTE_ID = 0x0911, /**< Average RMS voltage measurement period phase B */ ZB_ZCL_AVERAGE_RMS_OVER_VOLTAGE_COUNTER_PHASE_B_ATTRIBUTE_ID = 0x0912, /**< RMS over voltage counter phase B */ - ZB_ZCL_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_PHASE_B_ATTRIBUTE_ID = 0x0913, /**< Average RMS under vlotage counter phase B */ + ZB_ZCL_AVERAGE_RMS_UNDER_VOLTAGE_COUNTER_PHASE_B_ATTRIBUTE_ID = 0x0913, /**< Average RMS under voltage counter phase B */ ZB_ZCL_RMS_EXTREME_OVER_VOLTAGE_PERIOD_PHASE_B_ATTRIBUTE_ID = 0x0914, /**< RMS extreme over voltage period phase B */ ZB_ZCL_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHASE_B_ATTRIBUTE_ID = 0x0915, /**< RMS extreme under voltage period phase B */ ZB_ZCL_RMS_VOLTAGE_SAG_PERIOD_PHASE_B_ATTRIBUTE_ID = 0x0916, /**< RMS voltage sag period phase B */ @@ -1005,7 +1005,7 @@ typedef enum { ZB_ZCL_RMS_EXTREME_OVER_VOLTAGE_PERIOD_PHASE_C_ATTRIBUTE_ID = 0x0A14, /**< RMS extreme over voltage period phase C */ ZB_ZCL_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHASE_C_ATTRIBUTE_ID = 0x0A15, /**< RMS extreme under voltage period phase C */ ZB_ZCL_RMS_VOLTAGE_SAG_PERIOD_PHASE_C_ATTRIBUTE_ID = 0x0A16, /**< RMS voltage sag period phase C */ - ZB_ZCL_RMS_VOLTAGE_SWELL_PERIOD_PHASE_C_ATTRIBUTE_ID = 0x0A17, /**< RMS voltage swell peroid phase C */ + ZB_ZCL_RMS_VOLTAGE_SWELL_PERIOD_PHASE_C_ATTRIBUTE_ID = 0x0A17, /**< RMS voltage swell period phase C */ } zb_zcl_electrical_measurement_server_attributes_e; /** @@ -1017,9 +1017,9 @@ typedef enum { */ typedef enum { ZB_ZCL_NUMBER_OF_RESETS_ATTRIBUTE_ID = 0x0000, /**< Number of resets */ - ZB_ZCL_PERSISTENT_MEMORY_WRITES_ATTRIBUTE_ID = 0x0001, /**< Rersistent memory write */ + ZB_ZCL_PERSISTENT_MEMORY_WRITES_ATTRIBUTE_ID = 0x0001, /**< Persistent memory write */ ZB_ZCL_MAC_RX_BCAST_ATTRIBUTE_ID = 0x0100, /**< MAC Rx broadcast count */ - ZB_ZCL_MAC_TX_BCAST_ATTRIBUTE_ID = 0x0101, /**< MAC Tx broadcas count t */ + ZB_ZCL_MAC_TX_BCAST_ATTRIBUTE_ID = 0x0101, /**< MAC Tx broadcast count t */ ZB_ZCL_MAC_RX_UCAST_ATTRIBUTE_ID = 0x0102, /**< MAC Rx unicast */ ZB_ZCL_MAC_TX_UCAST_ATTRIBUTE_ID = 0x0103, /**< MAC Tx unicast */ ZB_ZCL_MAC_TX_UCAST_RETRY_ATTRIBUTE_ID = 0x0104, /**< MAC Tx unicast retry count */ @@ -1041,7 +1041,7 @@ typedef enum { ZB_ZCL_APS_UNAUTHORIZED_KEY_ATTRIBUTE_ID = 0x0114, /**< APS layer unauthorized key */ ZB_ZCL_NWK_DECRYPT_FAILURE_ATTRIBUTE_ID = 0x0115, /**< Network layer decrypt failure count */ ZB_ZCL_APS_DECRYPT_FAILURE_ATTRIBUTE_ID = 0x0116, /**< AOS layer decrypt failure count */ - ZB_ZCL_PACKET_BUFFER_ALLOC_FAILURES_ATTRIBUTE_ID = 0x0117, /**< Packet buffer allocation fauilure count */ + ZB_ZCL_PACKET_BUFFER_ALLOC_FAILURES_ATTRIBUTE_ID = 0x0117, /**< Packet buffer allocation failure count */ ZB_ZCL_RELAYED_UNICAST_ATTRIBUTE_ID = 0x0118, /**< Relayed unicast count */ ZB_ZCL_PHY_TO_MAC_QUEUE_LIMIT_REACHED_ATTRIBUTE_ID = 0x0119, /**< PHY to MAC queue limit reached */ ZB_ZCL_PACKET_VALIDATE_DROP_COUNT_ATTRIBUTE_ID = 0x011A, /**< Packet validate drop count */ diff --git a/include/zcl/zb_zcl_attribute_type.h b/include/zcl/zb_zcl_attribute_type.h index 5c1fde0..2a98774 100644 --- a/include/zcl/zb_zcl_attribute_type.h +++ b/include/zcl/zb_zcl_attribute_type.h @@ -92,9 +92,9 @@ typedef enum { ZB_ZCL_SIGNED_64_BIT_INTEGER = 0x2f, /**< signed 64-bit integer, 8-byte */ ZB_ZCL_8_BIT_ENUMERATION = 0x30, /**< 8-bit enumeration, 1-byte */ ZB_ZCL_16_BIT_ENUMERATION = 0x31, /**< 16-bit enumeration, 2-byte */ - ZB_ZCL_SEMI_PRECISION = 0x38, /**< foating point, 2-byte */ - ZB_ZCL_SINGLE_PRECISION = 0x39, /**< foating point, 4-byte */ - ZB_ZCL_DOUBLE_PRECISION = 0x3a, /**< foating point, 8-byte */ + ZB_ZCL_SEMI_PRECISION = 0x38, /**< floating point, 2-byte */ + ZB_ZCL_SINGLE_PRECISION = 0x39, /**< floating point, 4-byte */ + ZB_ZCL_DOUBLE_PRECISION = 0x3a, /**< floating point, 8-byte */ /**< Octat string, Defined in first two octat */ ZB_ZCL_OCTAT_STRING = 0x41, /**< Character string, Defined in first two octat */ diff --git a/include/zcl/zb_zcl_global_commands.h b/include/zcl/zb_zcl_global_commands.h index fcec6d9..745328b 100644 --- a/include/zcl/zb_zcl_global_commands.h +++ b/include/zcl/zb_zcl_global_commands.h @@ -48,12 +48,12 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] addr16 source network address - * @param[out] ep where is sent from (ex. 1) - * @param[out] cluster_id ZCL cluster id - * @param[out] records Response record - * @param[out] records_len Length of attribute status record - * @param[out] user_data User data + * @param[in] addr16 source network address + * @param[in] ep where is sent from (ex. 1) + * @param[in] cluster_id ZCL cluster id + * @param[in] records Response record + * @param[in] records_len Length of attribute status record + * @param[in] user_data User data * * @see zb_zcl_global_read_attr() * @see zb_zcl_global_write_attr() @@ -369,12 +369,12 @@ int zb_zcl_global_read_config_report( * * @since_tizen 4.0 * - * @param[out] addr16 source network address - * @param[out] ep where is sent from (ex. 1) - * @param[out] cluster_id ZCL cluster id - * @param[out] records Discover attribute information record - * @param[out] records_len Length of Discover attribute information record - * @param[out] user_data User data + * @param[in] addr16 source network address + * @param[in] ep where is sent from (ex. 1) + * @param[in] cluster_id ZCL cluster id + * @param[in] records Discover attribute information record + * @param[in] records_len Length of Discover attribute information record + * @param[in] user_data User data * * @see zb_zcl_global_discover_attr() */ @@ -570,16 +570,16 @@ int zb_zcl_global_write_attr_structured( * * @since_tizen 4.0 * - * @param[out] addr16 source network address - * @param[out] ep where is sent from (ex. 1) - * @param[out] cluster_id ZCL cluster id - * @param[out] discovery_complete which indicates whether the Command Discovery is + * @param[in] addr16 source network address + * @param[in] ep where is sent from (ex. 1) + * @param[in] cluster_id ZCL cluster id + * @param[in] discovery_complete which indicates whether the Command Discovery is * complete, i.e. whether there are any commands remaining to be discovered:\n * - TRUE - all commands have been discovered\n * - FALSE - there are further commands to be discovered\n - * @param[out] command_ids Discovered commands list - * @param[out] command_ids_len The number of discovered commands reported in this response - * @param[out] user_data User data + * @param[in] command_ids Discovered commands list + * @param[in] command_ids_len The number of discovered commands reported in this response + * @param[in] user_data User data * * @see zb_zcl_global_discover_cmd_received() */ @@ -708,17 +708,17 @@ int zb_zcl_global_discover_cmds_generated( * * @since_tizen 4.0 * - * @param[out] addr16 source network address - * @param[out] ep where is sent from (ex. 1) - * @param[out] cluster_id ZCL cluster id - * @param[out] discovery_complete which indicates whether the Command Discovery is + * @param[in] addr16 source network address + * @param[in] ep where is sent from (ex. 1) + * @param[in] cluster_id ZCL cluster id + * @param[in] discovery_complete which indicates whether the Command Discovery is * complete, i.e. whether there are any commands remaining to be discovered:\n * - TRUE - all commands have been discovered\n * - FALSE - there are further commands to be discovered\n - * @param[out] records Discovered attribute information list - * @param[out] records_len Len The number of discovered information\n + * @param[in] records Discovered attribute information list + * @param[in] records_len Len The number of discovered information\n * reported in this response - * @param[out] user_data User data + * @param[in] user_data User data * * @see zb_zcl_global_discover_attr_extended() */ diff --git a/include/zcl/zb_zcl_groups_cluster.h b/include/zcl/zb_zcl_groups_cluster.h index 72c88cf..21ab0c2 100644 --- a/include/zcl/zb_zcl_groups_cluster.h +++ b/include/zcl/zb_zcl_groups_cluster.h @@ -57,14 +57,14 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_DUPLICATE_EXISTS \n * #ZB_ZCL_INSUFFICIENT_SPACE - * @param[out] group_id Group id - * @param[out] user_data user data + * @param[in] group_id Group id + * @param[in] user_data user data * * @see zb_zcl_group_add_group() */ @@ -82,14 +82,14 @@ typedef void (*zb_zcl_group_add_group_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_NOT_FOUND - * @param[out] group_id Group id - * @param[out] group_name Group name - * @param[out] user_data user data + * @param[in] group_id Group id + * @param[in] group_name Group name + * @param[in] user_data user data * * @see zb_zcl_group_view_group() */ @@ -108,12 +108,12 @@ typedef void (*zb_zcl_group_view_group_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] capacity How many we can add to this group - * @param[out] group_count The number of groups contained in the group_list - * @param[out] group_list the identifiers either of all the groups in the group table - * @param[out] user_data user data + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] capacity How many we can add to this group + * @param[in] group_count The number of groups contained in the group_list + * @param[in] group_list the identifiers either of all the groups in the group table + * @param[in] user_data user data * * @see zb_zcl_group_view_group_membership() */ @@ -132,13 +132,13 @@ typedef void (*zb_zcl_group_get_group_membership_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_NOT_FOUND - * @param[out] group_id Group id - * @param[out] user_data user data + * @param[in] group_id Group id + * @param[in] user_data user data * * @see zb_zcl_group_add_group() */ diff --git a/include/zcl/zb_zcl_identify_cluster.h b/include/zcl/zb_zcl_identify_cluster.h index ae3fafd..a06d832 100644 --- a/include/zcl/zb_zcl_identify_cluster.h +++ b/include/zcl/zb_zcl_identify_cluster.h @@ -72,9 +72,9 @@ int zb_zcl_identify( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] identify_time Identify time - * @param[out] user_data user data + * @param[in] addr16 Network address + * @param[in] identify_time Identify time + * @param[in] user_data user data * * @see zb_zcl_identify_query() */ diff --git a/include/zcl/zb_zcl_poll_control_cluster.h b/include/zcl/zb_zcl_poll_control_cluster.h index 295cd64..1143a93 100644 --- a/include/zcl/zb_zcl_poll_control_cluster.h +++ b/include/zcl/zb_zcl_poll_control_cluster.h @@ -91,9 +91,9 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] user_data user data + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] user_data user data * * @see zb_zcl_pollctrl_set_long_poll_interval() * @see zb_zcl_pollctrl_set_short_poll_interval() diff --git a/include/zcl/zb_zcl_scenes_cluster.h b/include/zcl/zb_zcl_scenes_cluster.h index fc900ab..34a435e 100644 --- a/include/zcl/zb_zcl_scenes_cluster.h +++ b/include/zcl/zb_zcl_scenes_cluster.h @@ -65,15 +65,15 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_NOT_FOUND \n * #ZB_ZCL_INVALID_FIELD - * @param[out] group_id Group id - * @param[out] scene_id Scene id - * @param[out] user_data user data + * @param[in] group_id Group id + * @param[in] scene_id Scene id + * @param[in] user_data user data * * @see zb_zcl_group_add_scene() */ @@ -100,22 +100,22 @@ typedef void (*zb_zcl_scene_add_scene_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_NOT_FOUND \n * #ZB_ZCL_INVALID_FIELD - * @param[out] group_id Group id - * @param[out] scene_id Scene id - * @param[out] transition_time Transition time - * @param[out] scene_name Scene name - * @param[out] extension_field_sets Extension field sets, one per cluster\n + * @param[in] group_id Group id + * @param[in] scene_id Scene id + * @param[in] transition_time Transition time + * @param[in] scene_name Scene name + * @param[in] extension_field_sets Extension field sets, one per cluster\n * Extension field sets =\n * {{ClusterID 1, length 1, {extension field set 1}},\n * {ClusterID 2, length 2, {extension field set 2}}, ... }. - * @param[out] ext_len length of extension fields set - * @param[out] user_data user data + * @param[in] ext_len length of extension fields set + * @param[in] user_data user data * * @see zb_zcl_group_view_scene() */ @@ -141,14 +141,14 @@ typedef void (*zb_zcl_scene_view_scene_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_INVALID_FIELD \n - * @param[out] group_id Group id - * @param[out] scene_id Scene id - * @param[out] user_data user data + * @param[in] group_id Group id + * @param[in] scene_id Scene id + * @param[in] user_data user data * * @see zb_zcl_group_remove_scene() */ @@ -169,14 +169,14 @@ typedef void (*zb_zcl_scene_remove_scene_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_INVALID_FIELD \n - * @param[out] group_id Group id - * @param[out] scene_id Scene id - * @param[out] user_data user data + * @param[in] group_id Group id + * @param[in] scene_id Scene id + * @param[in] user_data user data * * @see zb_zcl_group_remove_all_scene() */ @@ -197,15 +197,15 @@ typedef void (*zb_zcl_scene_remove_all_scene_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_INVALID_FIELD \n * #ZB_ZCL_INSUFFICIENT_SPACE - * @param[out] group_id Group id - * @param[out] scene_id Scene id - * @param[out] user_data user data + * @param[in] group_id Group id + * @param[in] scene_id Scene id + * @param[in] user_data user data * * @see zb_zcl_group_store_scene() */ @@ -224,24 +224,24 @@ typedef void (*zb_zcl_scene_store_scene_rsp)( * * @since_tizen 4.0 * - * @param[out] addr16 Network address - * @param[out] ep Endpoint number - * @param[out] status Status code see zb_zcl_type.h\n + * @param[in] addr16 Network address + * @param[in] ep Endpoint number + * @param[in] status Status code see zb_zcl_type.h\n * #ZB_ZCL_SUCCESS \n * #ZB_ZCL_INVALID_FIELD \n - * @param[out] capacity The Capacity field shall contain the remaining capacity of the \n + * @param[in] capacity The Capacity field shall contain the remaining capacity of the \n * scene table of the device. (for all groups). The following values\n * apply:\n * 0 : No further scenes may be added.\n * 0 < Capacity < 0xfeCapacity holds the number of scenes that may be added\n * 0xfe : At least 1 further scene may be added (exact number is unknown)\n * 0xff : It is unknown if any further scenes may be added\n - * @param[out] group_id Group id - * @param[out] scene_count The Scene count field shall contain the number of scenes \n + * @param[in] group_id Group id + * @param[in] scene_count The Scene count field shall contain the number of scenes \n * contained in the Scene list field. - * @param[out] scene_list The Scene list field shall contain the identifiers of all the \n + * @param[in] scene_list The Scene list field shall contain the identifiers of all the \n * scenes in the scene table with the corresponding Group ID. - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zcl_scene_get_scene_membership() */ diff --git a/include/zcl/zb_zcl_type.h b/include/zcl/zb_zcl_type.h index b8da9cf..e2bddbd 100644 --- a/include/zcl/zb_zcl_type.h +++ b/include/zcl/zb_zcl_type.h @@ -268,7 +268,7 @@ typedef enum { ZB_GLOBAL_WRITE_ATTR, /**< Write attributes type */ ZB_GLOBAL_CONFIG_REPORT, /**< Configure reporting type */ ZB_GLOBAL_READ_REPORT_CONFIG, /**< Read reporting config type */ - ZB_GLOBAL_WRITE_ATTR_STRUCTURED/**< Write attributes structued type */ + ZB_GLOBAL_WRITE_ATTR_STRUCTURED/**< Write attributes structured type */ } zb_zcl_global_record_e; /** diff --git a/include/zdo/zb_zdo_bind_mgr.h b/include/zdo/zb_zdo_bind_mgr.h index 43fb51f..b74616e 100644 --- a/include/zdo/zb_zdo_bind_mgr.h +++ b/include/zdo/zb_zdo_bind_mgr.h @@ -54,12 +54,12 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * #ZB_ZDP_INVALID_EP \n * #ZB_ZDP_TABLE_FULL \n * #ZB_ZDP_NOT_AUTHORIZED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_bind_req() * @@ -139,12 +139,12 @@ int zb_zdo_bind_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * #ZB_ZDP_INVALID_EP \n * #ZB_ZDP_NO_ENTRY \n * #ZB_ZDP_NOT_AUTHORIZED - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_unbind_req_addr() * diff --git a/include/zdo/zb_zdo_dev_disc.h b/include/zdo/zb_zdo_dev_disc.h index d47f16a..f202835 100644 --- a/include/zdo/zb_zdo_dev_disc.h +++ b/include/zdo/zb_zdo_dev_disc.h @@ -51,26 +51,26 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_DEVICE_NOT_FOUND - * @param[out] remote_dev_addr64 64-bit address for the remote device - * @param[out] remote_dev_addr16 16-bit address for the remote device - * @param[out] num_of_assoc_dev Count of the number of 16-bit short addresses to follow. + * @param[in] remote_dev_addr64 64-bit address for the remote device + * @param[in] remote_dev_addr16 16-bit address for the remote device + * @param[in] num_of_assoc_dev Count of the number of 16-bit short addresses to follow. * If the RequestType in the request is Extended Response * and there are no associated devices on the Remote Device, * this field shall be set to 0. * If an error occurs or the RequestType in the request is * for a Single Device Response, this field shall not * be included in the frame. - * @param[out] start_idx Starting index into the list of associated devices for this + * @param[in] start_idx Starting index into the list of associated devices for this * report. If the RequestType in the request is Extended Response * and there are no associated devices on the Remote Device, * this field shall not be included in the frame. * If an error occurs or the RequestType in the request is * for a Single Device Response, this field shall not * be included in the frame. - * @param[out] assoc_dev_addr_list A list of 16-bit addresses, one corresponding to each + * @param[in] assoc_dev_addr_list A list of 16-bit addresses, one corresponding to each * associated device to Remote Device; The number of 16-bit * network addresses contained in this field is specified * in the NumAssocDev field. @@ -80,7 +80,7 @@ extern "C" { * If an error occurs or the RequestType in the request is * for a Single Device Response, this field shall not * be included in the frame. - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_nwk_addr_req() */ @@ -193,14 +193,14 @@ int zb_zdo_ieee_addr_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_DEVICE_NOT_FOUND \n * #ZB_ZDP_NO_DESCRIPTOR \n - * @param[out] addr16 Network address for the request - * @param[out] count The count of active endpoint on the remote device - * @param[out] ep_list List of bytes each of which represents an 8-bit endpoint - * @param[out] user_data user data + * @param[in] addr16 Network address for the request + * @param[in] count The count of active endpoint on the remote device + * @param[in] ep_list List of bytes each of which represents an 8-bit endpoint + * @param[in] user_data user data * * @see zb_zdo_active_ep() */ @@ -287,17 +287,17 @@ int zb_zdo_active_ep( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INVALID_EP \n * #ZB_ZDP_NOT_ACTIVE \n * #ZB_ZDP_DEVICE_NOT_FOUND \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_NO_DESCRIPTOR - * @param[out] addr16 Network address for the request - * @param[out] len Length in bytes of the simple descriptor to follow - * @param[out] handle Simple descriptor structure this filed shall only be included + * @param[in] addr16 Network address for the request + * @param[in] len Length in bytes of the simple descriptor to follow + * @param[in] handle Simple descriptor structure this filed shall only be included * in the frame if the status field is equal to ZB_ZDP_SUCCESS - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_simple_desc_req() */ @@ -373,28 +373,28 @@ int zb_zdo_simple_desc_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INVALID_EP \n * #ZB_ZDP_NOT_ACTIVE \n * #ZB_ZDP_DEVICE_NOT_FOUND \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_NO_DESCRIPTOR - * @param[out] addr16 Network address for the request - * @param[out] ep The endpoint on the destination - * @param[out] app_input_cluster_count The total count of application input cluster in + * @param[in] addr16 Network address for the request + * @param[in] ep The endpoint on the destination + * @param[in] app_input_cluster_count The total count of application input cluster in * the simple descriptor for this endpoint - * @param[out] app_output_cluster_count The total count of application output cluster in + * @param[in] app_output_cluster_count The total count of application output cluster in * the simple descriptor for this endpoint - * @param[out] start_idx Starting index within the AppClusterList of the response + * @param[in] start_idx Starting index within the AppClusterList of the response * represented by an ordered list of the Application Input * Cluster List and Application Output Cluster List from the * Simple Descriptor for this endpoint. - * @param[out] app_cluster_list A concatenated, ordered list of the AppInputClusterList + * @param[in] app_cluster_list A concatenated, ordered list of the AppInputClusterList * and AppOutputClusterList, beginning with StartIndex, * from the Simple Descriptor. * This field shall only be included in the frame if the * status field is equal to ZB_ZDP_SUCCESS. - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_extended_simple_desc_req() */ @@ -534,15 +534,15 @@ int zb_zdo_extended_simple_desc_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_DEVICE_NOT_FOUND \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_NO_DESCRIPTOR - * @param[out] addr16 Network address for the request - * @param[out] match_length The count of endpoint on the remote device that match + * @param[in] addr16 Network address for the request + * @param[in] match_length The count of endpoint on the remote device that match * the request criteria - * @param[out] match_list List of bytes each of which represents an 8-bit endpoint - * @param[out] user_data user data + * @param[in] match_list List of bytes each of which represents an 8-bit endpoint + * @param[in] user_data user data * * @see zb_zdo_match_desc_req() */ @@ -647,14 +647,14 @@ int zb_zdo_match_desc_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_DEVICE_NOT_FOUND \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_NO_DESCRIPTOR - * @param[out] addr16 Network address for the request - * @param[out] node_desc This field shall only be included in the frame if the + * @param[in] addr16 Network address for the request + * @param[in] node_desc This field shall only be included in the frame if the * status field is equal to ZB_ZDP_SUCCESS. - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_node_desc_req() */ @@ -729,14 +729,14 @@ int zb_zdo_node_desc_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_DEVICE_NOT_FOUND \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_NO_DESCRIPTOR - * @param[out] addr16 Network address for the request - * @param[out] power_desc This field shall only be included in the frame if the + * @param[in] addr16 Network address for the request + * @param[in] power_desc This field shall only be included in the frame if the * @ status field is equal to ZB_ZDP_SUCCESS. - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_power_desc_req() */ @@ -818,16 +818,16 @@ int zb_zdo_power_desc_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * #ZB_ZDP_DEVICE_NOT_FOUND \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_NO_DESCRIPTOR - * @param[out] addr16 Network address for the request - * @param[out] length Length in bytes of the complex_desc field - * @param[out] complex_desc This field shall only be included in the frame if the + * @param[in] addr16 Network address for the request + * @param[in] length Length in bytes of the complex_desc field + * @param[in] complex_desc This field shall only be included in the frame if the * @ status field is equal to ZB_ZDP_SUCCESS. - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_complex_desc_req() */ @@ -910,16 +910,16 @@ int zb_zdo_complex_desc_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * #ZB_ZDP_DEVICE_NOT_FOUND \n * #ZB_ZDP_INV_REQUESTTYPE \n * #ZB_ZDP_NO_DESCRIPTOR - * @param[out] addr16 Network address for the request - * @param[out] length Length in bytes of the user_desc field - * @param[out] user_desc This field shall only be included in the frame if the + * @param[in] addr16 Network address for the request + * @param[in] length Length in bytes of the user_desc field + * @param[in] user_desc This field shall only be included in the frame if the * status field is equal to ZB_ZDP_SUCCESS. - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_user_desc_req() */ @@ -997,9 +997,9 @@ int zb_zdo_user_desc_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * returned value from NLME-GET.confirm primitive \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_user_desc_req() */ diff --git a/include/zdo/zb_zdo_nwk_mgr.h b/include/zdo/zb_zdo_nwk_mgr.h index dfff316..11a875d 100644 --- a/include/zdo/zb_zdo_nwk_mgr.h +++ b/include/zdo/zb_zdo_nwk_mgr.h @@ -61,16 +61,16 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] status ZB_ZDP_NOT_SUPPORTED or returned value from NLME-NETWORK.DISCOVERY. + * @param[in] status ZB_ZDP_NOT_SUPPORTED or returned value from NLME-NETWORK.DISCOVERY. * request - * @param[out] network_count The total number of networks reported by the NLME-NETWORK- + * @param[in] network_count The total number of networks reported by the NLME-NETWORK- * DISCOVERY.confirm. - * @param[out] start_idx The starting point in the NetworkList from the NLME-NETWORK- + * @param[in] start_idx The starting point in the NetworkList from the NLME-NETWORK- * DISCOVERY.confirm where reporting begins for this response. - * @param[out] network_list_count The number of network list descriptors reported within + * @param[in] network_list_count The number of network list descriptors reported within * this response. - * @param[out] nwk_list A list of network list descriptors. - * @param[out] user_data User data + * @param[in] nwk_list A list of network list descriptors. + * @param[in] user_data User data * * @see zb_zdo_mgmt_nwk_disc_req() */ @@ -148,18 +148,18 @@ int zb_zdo_mgmt_nwk_disc_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * #ZB_ZDP_TABLE_FULL \n * #ZB_ZDP_INV_REQUESTTYPE \n - * @param[out] source_table_entries Total number of source table entries in the backup + * @param[in] source_table_entries Total number of source table entries in the backup * binding cache. - * @param[out] start_idx Starting index within the neighbor table to begin reporting for + * @param[in] start_idx Starting index within the neighbor table to begin reporting for * the neighbor table list. - * @param[out] neighbor_table_list_count The number of neighbor table entries included + * @param[in] neighbor_table_list_count The number of neighbor table entries included * within neighbor table list. - * @param[out] neighbor_table_list A list of neighbor table list. - * @param[out] user_data User data + * @param[in] neighbor_table_list A list of neighbor table list. + * @param[in] user_data User data * * @see zb_zdo_mgmt_lqi_req() */ @@ -217,17 +217,17 @@ int zb_zdo_mgmt_lqi_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * returned value from NLME-GET.confirm primitive \n - * @param[out] routing_table_entries Total number of routing table entries within the + * @param[in] routing_table_entries Total number of routing table entries within the * remote device. - * @param[out] start_idx Starting index within the Routing Table to begin reporting for + * @param[in] start_idx Starting index within the Routing Table to begin reporting for * the RoutingTableList. - * @param[out] routing_table_list_count The number of routing table entries included + * @param[in] routing_table_list_count The number of routing table entries included * within RoutingTableList. - * @param[out] neighbor_table_list A list of routing table list. - * @param[out] user_data User data + * @param[in] neighbor_table_list A list of routing table list. + * @param[in] user_data User data * * @see zb_zdo_mgmt_rtg_req() */ @@ -242,7 +242,7 @@ typedef void (*zb_zdo_mgmt_rtg_rsp)( /** * @brief Sends 'routing management request' command * @details The Mgmt_Rtg_req is generated from a Local Device wishing to retrieve the - * ontents of the Routing Table from the Remote Device. The destination + * contents of the Routing Table from the Remote Device. The destination * addressing on this command shall be unicast only and the destination address * must be that of the ZigBee Router or ZigBee Coordinator. * @@ -294,17 +294,17 @@ int zb_zdo_mgmt_rtg_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * returned value from NLME-GET.confirm primitive \n - * @param[out] binding_table_entries Total number of Binding Table entries within the + * @param[in] binding_table_entries Total number of Binding Table entries within the * Remote Device. - * @param[out] start_idx Starting index within the Binding Table to begin reporting for + * @param[in] start_idx Starting index within the Binding Table to begin reporting for * the BindingTableList. - * @param[out] binding_table_list_count The number of binding table entries included + * @param[in] binding_table_list_count The number of binding table entries included * within BindingTableList. - * @param[out] neighbor_table_list A list of routing table list. - * @param[out] user_data User data + * @param[in] neighbor_table_list A list of routing table list. + * @param[in] user_data User data * * @see zb_zdo_mgmt_bind_req() */ @@ -362,11 +362,11 @@ int zb_zdo_mgmt_bind_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * #ZB_ZDP_NOT_AUTHORIZED \n * returned value from NLME-LEAVE.confirm primitive \n - * @param[out] user_data User data + * @param[in] user_data User data * * @see zb_zdo_mgmt_leave_req() */ @@ -427,11 +427,11 @@ int zb_zdo_mgmt_leave_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * #ZB_ZDP_NOT_AUTHORIZED \n * returned value from NLME-DIRECT-JOIN.confirm primitive \n - * @param[out] user_data User data + * @param[in] user_data User data * * @see zb_zdo_mgmt_direct_join_rsp() */ @@ -487,11 +487,11 @@ int zb_zdo_mgmt_direct_join_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n * #ZB_ZDP_NOT_AUTHORIZED \n * returned value from NLME-DIRECT-JOINING.confirm primitive \n - * @param[out] user_data User data + * @param[in] user_data User data * * @see zb_zdo_mgmt_direct_join_rsp() */ @@ -564,14 +564,14 @@ int zb_zdo_mgmt_permit_joining_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] discovery_cache_entries discovery cache entries - * @param[out] start_idx data User data - * @param[out] discovery_cache_list_count The list shall contain the number of elements + * @param[in] discovery_cache_entries discovery cache entries + * @param[in] start_idx data User data + * @param[in] discovery_cache_list_count The list shall contain the number of elements * given by the DiscoveryCacheListCount parameter. - * @param[out] discover_cache_list A list of descriptors. - * @param[out] user_data User data + * @param[in] discover_cache_list A list of descriptors. + * @param[in] user_data User data * * @see zb_zdo_mgmt_cache_req() */ diff --git a/include/zdo/zb_zdo_svc_disc.h b/include/zdo/zb_zdo_svc_disc.h index 03c538b..6eb18a0 100644 --- a/include/zdo/zb_zdo_svc_disc.h +++ b/include/zdo/zb_zdo_svc_disc.h @@ -59,10 +59,10 @@ extern "C" { * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * returned value from NLME-GET.confirm primitive \n - * @param[out] server_mask Server Mask Bit Assignment - * @param[out] user_data user data + * @param[in] server_mask Server Mask Bit Assignment + * @param[in] user_data user data * * @see zb_zdo_system_server_discover_req() */ @@ -110,11 +110,11 @@ int zb_zdo_system_server_discover_req( * * @since_tizen 4.0 * - * @param[out] cache_nwk_addr NWK Address for the Primary Discovery Cache device holding + * @param[in] cache_nwk_addr NWK Address for the Primary Discovery Cache device holding * the discovery information. - * @param[out] addr16 Server NWK Address for the device of interest. - * @param[out] addr64 Server IEEE Address for the device of interest. - * @param[out] user_data user data + * @param[in] addr16 Server NWK Address for the device of interest. + * @param[in] addr64 Server IEEE Address for the device of interest. + * @param[in] user_data user data * * @see zb_zdo_find_node_cache_req() */ @@ -170,9 +170,9 @@ int zb_zdo_find_node_cache_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * returned value from NLME-GET.confirm primitive \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_discovery_cache_req() */ @@ -220,10 +220,10 @@ int zb_zdo_discovery_cache_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INSUFFICIENT_SPACE \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_discovery_store_req() */ @@ -282,11 +282,11 @@ int zb_zdo_discovery_store_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INSUFFICIENT_SPACE \n * #ZB_ZDP_NOT_PERMITED \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_node_desc_store_req() */ @@ -337,11 +337,11 @@ int zb_zdo_node_desc_store_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INSUFFICIENT_SPACE \n * #ZB_ZDP_NOT_PERMITED \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_power_desc_store_req() */ @@ -392,11 +392,11 @@ int zb_zdo_power_desc_store_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INSUFFICIENT_SPACE \n * #ZB_ZDP_NOT_PERMITED \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_active_ep_store_req() */ @@ -454,11 +454,11 @@ int zb_zdo_active_ep_store_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INSUFFICIENT_SPACE \n * #ZB_ZDP_NOT_PERMITED \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_simple_desc_store_req() */ @@ -514,11 +514,11 @@ int zb_zdo_simple_desc_store_req( * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_INSUFFICIENT_SPACE \n * #ZB_ZDP_NOT_PERMITED \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_zdo_remove_node_cache_req() */ diff --git a/include/zigbee.h b/include/zigbee.h index 9828d52..b9d268a 100644 --- a/include/zigbee.h +++ b/include/zigbee.h @@ -87,9 +87,9 @@ void zb_destroy(zigbee_h handle); * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_enable() */ @@ -147,10 +147,10 @@ int zb_enable(zigbee_h handle, zb_enable_cb cb, void *user_data); * @see #ZB_ZCL_SIMPLE_METERING_REMOVE_MIRROR_EVENT * @see #ZB_ZCL_SIMPLE_METERING_REQUEST_MIRROR_EVENT * - * @param[out] addr16 Network address (16 bit) from the source device - * @param[out] addr64 IEEE address (EUI64) from the source device - * @param[out] event_type The event identification - * @param[out] lparam parameter data pointer + * @param[in] addr16 Network address (16 bit) from the source device + * @param[in] addr64 IEEE address (EUI64) from the source device + * @param[in] event_type The event identification + * @param[in] lparam parameter data pointer * * @pre The callback must be registered when using zb_set_event_handler() * @@ -265,8 +265,8 @@ int zb_coex_stop(zigbee_h handle); * * @since_tizen 4.0 * - * @param[out] panid PAN ID - * @param[out] user_data user data + * @param[in] panid PAN ID + * @param[in] user_data user data * * @see zb_form_network() */ @@ -303,9 +303,9 @@ int zb_form_network(zigbee_h handle, zb_form_network_cb cb, void *user_data); * * @since_tizen 4.0 * - * @param[out] status #ZB_ZDP_SUCCESS \n + * @param[in] status #ZB_ZDP_SUCCESS \n * #ZB_ZDP_NOT_SUPPORTED \n - * @param[out] user_data user data + * @param[in] user_data user data * * @see zb_form_network() */ @@ -503,9 +503,9 @@ int zb_device_list_free(zb_end_device_info_h *list); * * @since_tizen 4.0 * - * @param[out] index nth child - * @param[out] child handle of a end-device - * @param[out] user_data user data + * @param[in] index nth child + * @param[in] child handle of a end-device + * @param[in] user_data user data * * @pre The callback must be registered when using zb_devices_info_foreach_end_device() * -- 2.34.1