From 3bd69dac73b0c63e35cd2022344e6a357d90da43 Mon Sep 17 00:00:00 2001 From: Rishi Dev Singh Date: Tue, 22 Dec 2015 11:43:31 +0530 Subject: [PATCH] Zbee(zc): Changing comment format(javadoc=>Doxygen) Change-Id: Ic0b5d7139e324cbbe786cb4a0cf7d9f924acdf04 Reviewed-on: https://code.wireshark.org/review/12818 Petri-Dish: Alexis La Goutte Tested-by: Petri Dish Buildbot Reviewed-by: Alexis La Goutte Reviewed-by: Michael Mann --- epan/dissectors/packet-zbee-nwk-gp.c | 404 ++++------ epan/dissectors/packet-zbee-zcl-ha.c | 395 ++++------ .../dissectors/packet-zbee-zcl-meas-sensing.c | 686 ++++++----------- epan/dissectors/packet-zbee-zcl-misc.c | 239 ++---- epan/dissectors/packet-zbee-zcl-se.c | 696 ++++++------------ epan/dissectors/packet-zbee-zcl.c | 557 ++++++-------- 6 files changed, 1019 insertions(+), 1958 deletions(-) diff --git a/epan/dissectors/packet-zbee-nwk-gp.c b/epan/dissectors/packet-zbee-nwk-gp.c index 4abc868f37..9d6a596946 100644 --- a/epan/dissectors/packet-zbee-nwk-gp.c +++ b/epan/dissectors/packet-zbee-nwk-gp.c @@ -547,20 +547,13 @@ uat_key_record_free_cb(void *r) } } -/*FUNCTION:------------------------------------------------------ - * NAME - * zbee_gp_security_parse_key - * DESCRIPTION - * Parses a key string from left to right into a buffer with increasing (normal byte order) or decreasing (reverse - * byte order) address. - * PARAMETERS - * const gchar *key_str - pointer to the string - * guint8 *key_buf - destination buffer in memory - * gboolean byte_order - byte order - * RETURNS - * gboolean - *--------------------------------------------------------------- - */ +/** + *Parses a key string from left to right into a buffer with increasing (normal byte order) or decreasing (reverse + * + *@param key_str pointer to the string + *@param key_buf destination buffer in memory + *@param byte_order byte order +*/ static gboolean zbee_gp_security_parse_key(const gchar *key_str, guint8 *key_buf, gboolean byte_order) { @@ -637,21 +630,16 @@ uat_key_record_update_cb(void *r, char **err) return TRUE; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_commissioning - * DESCRIPTION - * Dissector for ZigBee Green Power commissioning. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power commissioning. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_commissioning(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -745,21 +733,16 @@ dissect_zbee_nwk_gp_cmd_commissioning(tvbuff_t *tvb, packet_info *pinfo _U_, pro return offset; } /* dissect_zbee_nwk_gp_cmd_commissioning */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_channel_request - * DESCRIPTION - * Dissector for ZigBee Green Power channel request. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power channel request. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_channel_request(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -776,21 +759,16 @@ dissect_zbee_nwk_gp_cmd_channel_request(tvbuff_t *tvb, packet_info *pinfo _U_, p return offset; } /* dissect_zbee_nwk_gp_cmd_channel_request */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_channel_configuration - * DESCRIPTION - * Dissector for ZigBee Green Power channel configuration. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power channel configuration. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_channel_configuration(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -807,21 +785,16 @@ dissect_zbee_nwk_gp_cmd_channel_configuration(tvbuff_t *tvb, packet_info *pinfo return offset; } /* dissect_zbee_nwk_gp_cmd_channel_configuration */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_attr_reporting - * DESCRIPTION - * Dissector for ZigBee Green Power commands attrib reporting. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power commands attrib reporting. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_attr_reporting(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -842,21 +815,16 @@ dissect_zbee_nwk_gp_cmd_attr_reporting(tvbuff_t *tvb, packet_info *pinfo _U_, pr return offset; } /* dissect_zbee_nwk_gp_cmd_attr_reporting */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_commissioning_reply - * DESCRIPTION - * Dissector for ZigBee Green Power comissioning reply. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power comissioning reply. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_commissioning_reply(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -896,21 +864,16 @@ dissect_zbee_nwk_gp_cmd_commissioning_reply(tvbuff_t *tvb, packet_info *pinfo _U return offset; } /* dissect_zbee_nwk_gp_cmd_commissioning_reply */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_move_color - * DESCRIPTION - * Dissector for ZigBee Green Power Move Color. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power Move Color. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_move_color(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -922,21 +885,16 @@ dissect_zbee_nwk_gp_cmd_move_color(tvbuff_t *tvb, packet_info *pinfo _U_, proto_ return offset; } /* dissect_zbee_nwk_gp_cmd_move_color */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_move_up_down - * DESCRIPTION - * Dissector for ZigBee Green Power Move Up/Down. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power Move Up/Down. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_move_up_down(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -946,21 +904,16 @@ dissect_zbee_nwk_gp_cmd_move_up_down(tvbuff_t *tvb, packet_info *pinfo _U_, prot return offset; } /* dissect_zbee_nwk_gp_cmd_move_up_down */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_step_color - * DESCRIPTION - * Dissector for ZigBee Green Power Step Color. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power Step Color. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_step_color(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -977,21 +930,16 @@ dissect_zbee_nwk_gp_cmd_step_color(tvbuff_t *tvb, packet_info *pinfo _U_, proto_ return offset; } /* dissect_zbee_nwk_gp_cmd_step_color */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd_step_up_down - * DESCRIPTION - * Dissector for ZigBee Green Power Step Up/Down. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * zbee_nwk_green_power_packet *packet - packet data. - * guint offset - current payload offset. - * RETURNS - * guint - payload processed offset. - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power Step Up/Down. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param packet packet data. + *@param offset current payload offset. + *@return payload processed offset. +*/ static guint dissect_zbee_nwk_gp_cmd_step_up_down(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, zbee_nwk_green_power_packet *packet _U_, guint offset) @@ -1003,20 +951,15 @@ dissect_zbee_nwk_gp_cmd_step_up_down(tvbuff_t *tvb, packet_info *pinfo _U_, prot return offset; } /* dissect_zbee_nwk_gp_cmd_step_up_down */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp_cmd - * DESCRIPTION - * Dissector for ZigBee Green Power commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * void *data - raw packet private data. - * RETURNS - * guint - payload processed offset - *--------------------------------------------------------------- - */ +/** + *Dissector for ZigBee Green Power commands. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param data raw packet private data. + *@return payload processed offset +*/ static guint dissect_zbee_nwk_gp_cmd(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data) { @@ -1152,18 +1095,12 @@ dissect_zbee_nwk_gp_cmd(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, voi return offset; } /* dissect_zbee_nwk_gp_cmd */ -/*FUNCTION:------------------------------------------------------ - * NAME - * zbee_sec_make_nonce - * DESCRIPTION - * Fills in ZigBee GP security nonce from the provided packet structure. - * PARAMETERS - * zbee_nwk_green_power_packet *packet - ZigBee NWK packet. - * gchar *nonce - nonce buffer. - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Fills in ZigBee GP security nonce from the provided packet structure. + * + *@param packet ZigBee NWK packet. + *@param nonce nonce buffer. +*/ static void zbee_gp_make_nonce(zbee_nwk_green_power_packet *packet, gchar *nonce) { @@ -1192,23 +1129,17 @@ zbee_gp_make_nonce(zbee_nwk_green_power_packet *packet, gchar *nonce) /* TODO: implement if application_id != ZB_ZGP_APP_ID_0000. */ } -/*FUNCTION:------------------------------------------------------ - * NAME - * zbee_sec_decrypt_payload - * DESCRIPTION - * Creates a nonce and decrypts secured ZigBee GP payload. - * PARAMETERS - * zbee_nwk_green_power_packet *packet - ZigBee NWK packet. - * const gchar *enc_buffer - encoded payload buffer. - * const gchar offset - payload offset. - * guint8 *dec_buffer - decoded payload buffer. - * guint payload_len - payload length. - * guint mic_len - MIC length. - * guint8 *key - key. - * RETURNS - * gboolean - *--------------------------------------------------------------- - */ +/** + *Creates a nonce and decrypts secured ZigBee GP payload. + * + *@param packet ZigBee NWK packet. + *@param enc_buffer encoded payload buffer. + *@param offset payload offset. + *@param dec_buffer decoded payload buffer. + *@param payload_len payload length. + *@param mic_len MIC length. + *@param key key. +*/ static gboolean zbee_gp_decrypt_payload(zbee_nwk_green_power_packet *packet, const gchar *enc_buffer, const gchar offset, guint8 *dec_buffer, guint payload_len, guint mic_len, guint8 *key) @@ -1225,20 +1156,14 @@ zbee_gp_decrypt_payload(zbee_nwk_green_power_packet *packet, const gchar *enc_bu return FALSE; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_gp - * DESCRIPTION - * ZigBee NWK packet dissection routine for Green Power profile. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * void *data - raw packet private data. - * RETURNS - * int - *--------------------------------------------------------------- - */ +/** + *ZigBee NWK packet dissection routine for Green Power profile. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param data raw packet private data. +*/ static int dissect_zbee_nwk_gp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data) { @@ -1390,20 +1315,14 @@ dissect_zbee_nwk_gp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *d return tvb_captured_length(tvb); } /* dissect_zbee_nwk_gp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_nwk_heur_gp - * DESCRIPTION - * Heuristic interpreter for the ZigBee Green Power dissectors. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * void *data - raw packet private data. - * RETURNS - * Boolean value, whether it handles the packet or not. - *--------------------------------------------------------------- - */ +/** + *Heuristic interpreter for the ZigBee Green Power dissectors. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param data raw packet private data. +*/ static gboolean dissect_zbee_nwk_heur_gp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data) { @@ -1435,17 +1354,10 @@ dissect_zbee_nwk_heur_gp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, vo return FALSE; } /* dissect_zbee_nwk_heur_gp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * gp_init_zbee_security - * DESCRIPTION - * Init routine for the ZigBee GP profile security. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Init routine for the ZigBee GP profile security. + * +*/ static void gp_init_zbee_security(void) { @@ -1484,17 +1396,10 @@ gp_cleanup_zbee_security(void) zbee_gp_keyring = NULL; } -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_nwk_gp - * DESCRIPTION - * ZigBee NWK GP protocol registration routine. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *ZigBee NWK GP protocol registration routine. + * +*/ void proto_register_zbee_nwk_gp(void) { @@ -1784,17 +1689,10 @@ proto_register_zbee_nwk_gp(void) register_dissector(ZBEE_PROTOABBREV_NWK_GP, dissect_zbee_nwk_gp, proto_zbee_nwk_gp); } /* proto_register_zbee_nwk_gp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_nwk_gp - * DESCRIPTION - * Registers the ZigBee dissector with Wireshark. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Registers the ZigBee dissector with Wireshark. + * +*/ void proto_reg_handoff_zbee_nwk_gp(void) { diff --git a/epan/dissectors/packet-zbee-zcl-ha.c b/epan/dissectors/packet-zbee-zcl-ha.c index db51c03bbb..3befb04c31 100644 --- a/epan/dissectors/packet-zbee-zcl-ha.c +++ b/epan/dissectors/packet-zbee-zcl-ha.c @@ -203,41 +203,28 @@ static const value_string zbee_zcl_appl_idt_ceced_spec_ver_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_appl_idt - * DESCRIPTION - * ZigBee ZCL Appliance Identification cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Appliance Identification cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_appl_idt(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, void* data _U_) { return tvb_captured_length(tvb); } /*dissect_zbee_zcl_appl_idt*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_appl_idt_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ void dissect_zcl_appl_idt_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -296,18 +283,10 @@ dissect_zcl_appl_idt_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, g } /*dissect_zcl_appl_idt_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_appl_idt - * DESCRIPTION - * this function registers the ZCL Appliance Identification dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Appliance Identification dissector + * +*/ void proto_register_zbee_zcl_appl_idt(void) { @@ -358,17 +337,10 @@ proto_register_zbee_zcl_appl_idt(void) register_dissector(ZBEE_PROTOABBREV_ZCL_APPLIDT, dissect_zbee_zcl_appl_idt, proto_zbee_zcl_appl_idt); } /*proto_register_zbee_zcl_appl_idt*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_appl_idt - * DESCRIPTION - * Hands off the Zcl Appliance Identification dissector. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Hands off the Zcl Appliance Identification dissector. + * +*/ void proto_reg_handoff_zbee_zcl_appl_idt(void) { @@ -492,41 +464,28 @@ static const value_string zbee_zcl_met_idt_data_quality_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_met_idt - * DESCRIPTION - * ZigBee ZCL Meter Identification cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Meter Identification cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_met_idt(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, void* data _U_) { return tvb_captured_length(tvb); } /*dissect_zbee_zcl_met_idt*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_met_idt_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ void dissect_zcl_met_idt_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -550,18 +509,10 @@ dissect_zcl_met_idt_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, gu } /*dissect_zcl_met_idt_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_met_idt - * DESCRIPTION - * this function registers the ZCL Meter Identification dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Meter Identification dissector + * +*/ void proto_register_zbee_zcl_met_idt(void) { @@ -589,17 +540,10 @@ proto_register_zbee_zcl_met_idt(void) register_dissector(ZBEE_PROTOABBREV_ZCL_METIDT, dissect_zbee_zcl_met_idt, proto_zbee_zcl_met_idt); } /*proto_register_zbee_zcl_met_idt*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_met_idt - * DESCRIPTION - * Hands off the Zcl Meter Identification dissector. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Hands off the Zcl Meter Identification dissector. + * +*/ void proto_reg_handoff_zbee_zcl_met_idt(void) { @@ -743,19 +687,13 @@ static const value_string zbee_zcl_appl_evtalt_status_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_appl_evtalt - * DESCRIPTION - * ZigBee ZCL Appliance Events and Alerts cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Appliance Events and Alerts cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_appl_evtalt(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { @@ -831,19 +769,13 @@ dissect_zbee_zcl_appl_evtalt(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree return tvb_captured_length(tvb); } /*dissect_zbee_zcl_appl_evtalt*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_appl_evtalt_alerts_struct - * DESCRIPTION - * This function is called in order to decode alerts structure payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * guint *offset - offset in the tvb buffer - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called in order to decode alerts structure payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset offset in the tvb buffer +*/ static void dissect_zcl_appl_evtalt_alerts_struct(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -855,19 +787,13 @@ dissect_zcl_appl_evtalt_alerts_struct(tvbuff_t *tvb, proto_tree *tree, guint *of *offset += 3; } /*dissect_zcl_appl_evtalt_alerts_struct*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_appl_evtalt_get_alerts - * DESCRIPTION - * This function is called in order to decode the GetAlertsRespose payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * guint *offset - offset in the tvb buffer - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called in order to decode the GetAlertsRespose payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset offset in the tvb buffer +*/ static void dissect_zcl_appl_evtalt_get_alerts_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -892,19 +818,13 @@ dissect_zcl_appl_evtalt_get_alerts_rsp(tvbuff_t *tvb, proto_tree *tree, guint *o } } /*dissect_zcl_appl_evtalt_get_alerts_rsp*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_appl_evtalt_event_notif - * DESCRIPTION - * This function is called in order to decode the EventNotification payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * guint *offset - offset in the tvb buffer - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called in order to decode the EventNotification payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset offset in the tvb buffer +*/ static void dissect_zcl_appl_evtalt_event_notif(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -916,18 +836,10 @@ dissect_zcl_appl_evtalt_event_notif(tvbuff_t *tvb, proto_tree *tree, guint *offs *offset += 1; } /*dissect_zcl_appl_evtalt_event_notif*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_appl_evtalt - * DESCRIPTION - * this function registers the ZCL Appliance Events and Alert dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Appliance Events and Alert dissector + * +*/ void proto_register_zbee_zcl_appl_evtalt(void) { @@ -1001,17 +913,10 @@ proto_register_zbee_zcl_appl_evtalt(void) register_dissector(ZBEE_PROTOABBREV_ZCL_APPLEVTALT, dissect_zbee_zcl_appl_evtalt, proto_zbee_zcl_appl_evtalt); } /*proto_register_zbee_zcl_appl_evtalt*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_appl_evtalt - * DESCRIPTION - * Hands off the Zcl Appliance Events And Alerts dissector. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Hands off the Zcl Appliance Events And Alerts dissector. + * +*/ void proto_reg_handoff_zbee_zcl_appl_evtalt(void) { @@ -1122,19 +1027,13 @@ static const value_string zbee_zcl_appl_stats_srv_tx_cmd_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_appl_stats - * DESCRIPTION - * ZigBee ZCL Appliance Statistics cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Appliance Statistics cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_appl_stats (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { @@ -1215,19 +1114,13 @@ dissect_zbee_zcl_appl_stats (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree return tvb_captured_length(tvb); } /*dissect_zbee_zcl_appl_stats*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_appl_stats_log_req - * DESCRIPTION - * this function is called in order to decode "LogRequest" payload command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * guint *offset - pointer to buffer offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called in order to decode "LogRequest" payload command. + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to buffer offset +*/ static void dissect_zcl_appl_stats_log_req(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1236,20 +1129,13 @@ dissect_zcl_appl_stats_log_req(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += 4; } /*dissect_zcl_appl_stats_log_req*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_appl_stats_log_rsp - * DESCRIPTION - * this function is called in order to decode "LogNotification" and - * "LogResponse" payload command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * guint *offset - pointer to buffer offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called in order to decode "LogNotification" and + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to buffer offset +*/ static void dissect_zcl_appl_stats_log_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1273,20 +1159,13 @@ dissect_zcl_appl_stats_log_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += log_len; }/*dissect_zcl_appl_stats_log_rsp*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_appl_stats_log_queue_rsp - * DESCRIPTION - * this function is called in order to decode "LogQueueResponse" and - * "StatisticsAvailable" payload command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * guint *offset - pointer to buffer offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called in order to decode "LogQueueResponse" and + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to buffer offset +*/ static void dissect_zcl_appl_stats_log_queue_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1307,19 +1186,12 @@ dissect_zcl_appl_stats_log_queue_rsp(tvbuff_t *tvb, proto_tree *tree, guint *off } }/*dissect_zcl_appl_stats_log_queue_rsp*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_zcl_appl_stats_utc_time - * DESCRIPTION - * this function decodes utc time, with peculiarity case for - * appliance statitics specifications. - * PARAMETERS - * guint *s - string to display - * guint32 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes utc time, with peculiarity case for + * + *@param s string to display + *@param value value to decode +*/ static void decode_zcl_appl_stats_utc_time(gchar *s, guint32 value) { @@ -1334,18 +1206,10 @@ decode_zcl_appl_stats_utc_time(gchar *s, guint32 value) } } /* decode_zcl_appl_stats_utc_time */ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_appl_stats - * DESCRIPTION - * this function registers the ZCL Appliance Statistics dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Appliance Statistics dissector + * +*/ void proto_register_zbee_zcl_appl_stats(void) { @@ -1407,17 +1271,10 @@ proto_register_zbee_zcl_appl_stats(void) register_dissector(ZBEE_PROTOABBREV_ZCL_APPLSTATS, dissect_zbee_zcl_appl_stats, proto_zbee_zcl_appl_stats); } /* proto_register_zbee_zcl_appl_stats */ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_appl_stats - * DESCRIPTION - * Hands off the Zcl Appliance Statistics cluster dissector. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Hands off the Zcl Appliance Statistics cluster dissector. + * +*/ void proto_reg_handoff_zbee_zcl_appl_stats(void) { diff --git a/epan/dissectors/packet-zbee-zcl-meas-sensing.c b/epan/dissectors/packet-zbee-zcl-meas-sensing.c index ea4787b03d..166f3bc59e 100644 --- a/epan/dissectors/packet-zbee-zcl-meas-sensing.c +++ b/epan/dissectors/packet-zbee-zcl-meas-sensing.c @@ -126,41 +126,28 @@ static const value_string zbee_zcl_illum_meas_sensor_type_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_illum_meas - * DESCRIPTION - * ZigBee ZCL Illuminance Measurement cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Illuminance Measurement cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_illum_meas(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, void* data _U_) { return tvb_captured_length(tvb); } /*dissect_zbee_zcl_illum_meas*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_illum_meas_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_illum_meas_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -198,18 +185,12 @@ dissect_zcl_illum_meas_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, } } /*dissect_zcl_illum_meas_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_illum_meas_value - * DESCRIPTION - * this function decodes illuminance value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes illuminance value + * + *@param s string to display + *@param value value to decode +*/ static void decode_illum_meas_value(gchar *s, guint16 value) { @@ -224,18 +205,12 @@ decode_illum_meas_value(gchar *s, guint16 value) return; } /*decode_illum_meas_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_illum_meas_min_value - * DESCRIPTION - * this function decodes minimum illuminance value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes minimum illuminance value + * + *@param s string to display + *@param value value to decode +*/ static void decode_illum_meas_min_value(gchar *s, guint16 value) { @@ -248,18 +223,12 @@ decode_illum_meas_min_value(gchar *s, guint16 value) return; } /*decode_illum_meas_min_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_illum_meas_max_value - * DESCRIPTION - * this function decodes maximum illuminance value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes maximum illuminance value + * + *@param s string to display + *@param value value to decode +*/ static void decode_illum_meas_max_value(gchar *s, guint16 value) { @@ -272,18 +241,12 @@ decode_illum_meas_max_value(gchar *s, guint16 value) return; } /*decode_illum_meas_max_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_illum_meas_tolerance - * DESCRIPTION - * this function decodes tolerance value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes tolerance value + * + *@param s string to display + *@param value value to decode +*/ static void decode_illum_meas_tolerance(gchar *s, guint16 value) { @@ -295,18 +258,10 @@ decode_illum_meas_tolerance(gchar *s, guint16 value) return; } /*decode_illum_meas_tolerance*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_illum_meas - * DESCRIPTION - * this function registers the ZCL Illuminance Measurement dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Illuminance Measurement dissector + * +*/ void proto_register_zbee_zcl_illum_meas(void) { @@ -348,17 +303,10 @@ proto_register_zbee_zcl_illum_meas(void) } /*proto_register_zbee_zcl_illum_meas*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_illum_meas - * DESCRIPTION - * Hands off the ZCL Illuminance Measurement dissector. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Hands off the ZCL Illuminance Measurement dissector. + * +*/ void proto_reg_handoff_zbee_zcl_illum_meas(void) { @@ -455,41 +403,28 @@ static const value_string zbee_zcl_illum_level_sen_level_status_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_illum_level_sen - * DESCRIPTION - * ZigBee ZCL Illuminance Level Sensing cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Illuminance Level Sensing cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_illum_level_sen(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, void* data _U_) { return tvb_captured_length(tvb); } /*dissect_zbee_zcl_illum_level_sen*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_illum_level_sen_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_illum_level_sen_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -517,18 +452,12 @@ dissect_zcl_illum_level_sen_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *of } } /*dissect_zcl_illum_level_sen_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_illum_level_sen_target_level - * DESCRIPTION - * this function decodes illuminance value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes illuminance value + * + *@param s string to display + *@param value value to decode +*/ static void decode_illum_level_sen_target_level(gchar *s, guint16 value) { @@ -543,18 +472,10 @@ decode_illum_level_sen_target_level(gchar *s, guint16 value) return; } /*decode_illum_level_sen_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_illum_level_sen - * DESCRIPTION - * this function registers the ZCL Illuminance Level Sensing dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Illuminance Level Sensing dissector + * +*/ void proto_register_zbee_zcl_illum_level_sen(void) { @@ -587,17 +508,10 @@ proto_register_zbee_zcl_illum_level_sen(void) } /*proto_register_zbee_zcl_illum_level_sen*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_illum_level_sen - * DESCRIPTION - * Hands off the ZCL Illuminance Level Sensing dissector. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Hands off the ZCL Illuminance Level Sensing dissector. + * +*/ void proto_reg_handoff_zbee_zcl_illum_level_sen(void) { @@ -689,41 +603,28 @@ static const value_string zbee_zcl_temp_meas_attr_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_temp_meas - * DESCRIPTION - * ZigBee ZCL Temperature Measurement cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Temperature Measurement cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_temp_meas(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, void* data _U_) { return tvb_captured_length(tvb); } /*dissect_zbee_zcl_temp_meas*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_temp_meas_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_temp_meas_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -757,18 +658,12 @@ dissect_zcl_temp_meas_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, } /*dissect_zcl_temp_meas_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_temp_meas_value - * DESCRIPTION - * this function decodes temperature value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes temperature value + * + *@param s string to display + *@param value value to decode +*/ static void decode_temp_meas_value(gchar *s, gint16 value) { @@ -780,18 +675,12 @@ decode_temp_meas_value(gchar *s, gint16 value) return; } /*decode_temp_meas_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_temp_meas_min_value - * DESCRIPTION - * this function decodes minimum temperature value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes minimum temperature value + * + *@param s string to display + *@param value value to decode +*/ static void decode_temp_meas_min_value(gchar *s, gint16 value) { @@ -804,18 +693,12 @@ decode_temp_meas_min_value(gchar *s, gint16 value) return; } /*decode_temp_meas_min_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_temp_meas_max_value - * DESCRIPTION - * this function decodes maximum temperature value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes maximum temperature value + * + *@param s string to display + *@param value value to decode +*/ static void decode_temp_meas_max_value(gchar *s, gint16 value) { @@ -827,18 +710,12 @@ decode_temp_meas_max_value(gchar *s, gint16 value) return; } /*decode_temp_meas_max_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_temp_meas_tolerance - * DESCRIPTION - * this function decodes tolerance value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes tolerance value + * + *@param s string to display + *@param value value to decode +*/ static void decode_temp_meas_tolerance(gchar *s, guint16 value) { @@ -850,18 +727,10 @@ decode_temp_meas_tolerance(gchar *s, guint16 value) return; } /*decode_temp_meas_tolerance*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_temp_meas - * DESCRIPTION - * this function registers the ZCL Temperature Measurement dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Temperature Measurement dissector + * +*/ void proto_register_zbee_zcl_temp_meas(void) { @@ -897,17 +766,10 @@ proto_register_zbee_zcl_temp_meas(void) register_dissector(ZBEE_PROTOABBREV_ZCL_TEMPMEAS, dissect_zbee_zcl_temp_meas, proto_zbee_zcl_temp_meas); } /*proto_register_zbee_zcl_temp_meas*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_temp_meas - * DESCRIPTION - * Hands off the ZCL Temperature Measurement dissector. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Hands off the ZCL Temperature Measurement dissector. + * +*/ void proto_reg_handoff_zbee_zcl_temp_meas(void) { @@ -1016,41 +878,28 @@ static const value_string zbee_zcl_press_meas_attr_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_press_meas - * DESCRIPTION - * ZigBee ZCL Pressure Measurement cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Pressure Measurement cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_press_meas(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, void* data _U_) { return tvb_captured_length(tvb); } /*dissect_zbee_zcl_press_meas*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_press_meas_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_press_meas_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -1108,18 +957,12 @@ dissect_zcl_press_meas_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, } } /*dissect_zcl_press_meas_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_press_meas_value - * DESCRIPTION - * this function decodes pressure value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes pressure value + * + *@param s string to display + *@param value value to decode +*/ static void decode_press_meas_value(gchar *s, gint16 value) { @@ -1133,18 +976,12 @@ decode_press_meas_value(gchar *s, gint16 value) return; } /*decode_press_meas_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_press_meas_min_value - * DESCRIPTION - * this function decodes minimum pressure value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes minimum pressure value + * + *@param s string to display + *@param value value to decode +*/ static void decode_press_meas_min_value(gchar *s, gint16 value) { @@ -1156,18 +993,12 @@ decode_press_meas_min_value(gchar *s, gint16 value) return; } /*decode_press_meas_min_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_press_meas_max_value - * DESCRIPTION - * this function decodes maximum pressure value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes maximum pressure value + * + *@param s string to display + *@param value value to decode +*/ static void decode_press_meas_max_value(gchar *s, gint16 value) { @@ -1179,18 +1010,12 @@ decode_press_meas_max_value(gchar *s, gint16 value) return; } /*decode_press_meas_max_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_press_meas_tolerance - * DESCRIPTION - * this function decodes tolerance value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes tolerance value + * + *@param s string to display + *@param value value to decode +*/ static void decode_press_meas_tolerance(gchar *s, guint16 value) { @@ -1202,18 +1027,10 @@ decode_press_meas_tolerance(gchar *s, guint16 value) return; } /*decode_press_meas_tolerance*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_press_meas - * DESCRIPTION - * this function registers the ZCL Pressure Measurement dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Pressure Measurement dissector + * +*/ void proto_register_zbee_zcl_press_meas(void) { @@ -1269,17 +1086,10 @@ proto_register_zbee_zcl_press_meas(void) register_dissector(ZBEE_PROTOABBREV_ZCL_PRESSMEAS, dissect_zbee_zcl_press_meas, proto_zbee_zcl_press_meas); } /*proto_register_zbee_zcl_press_meas*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_press_meas - * DESCRIPTION - * Hands off the ZCL Pressure Measurement dissector. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Hands off the ZCL Pressure Measurement dissector. + * +*/ void proto_reg_handoff_zbee_zcl_press_meas(void) { @@ -1631,41 +1441,28 @@ static const value_string zbee_zcl_relhum_meas_attr_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_relhum_meas - * DESCRIPTION - * ZigBee ZCL Relative Humidity Measurement cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Relative Humidity Measurement cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_relhum_meas(tvbuff_t *tvb _U_, packet_info *pinfo _U_, proto_tree *tree _U_, void* data _U_) { return tvb_captured_length(tvb); } /*dissect_zbee_zcl_relhum_meas*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_relhum_meas_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_relhum_meas_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -1698,18 +1495,12 @@ dissect_zcl_relhum_meas_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset } } /*dissect_zcl_relhum_meas_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_relhum_meas_value - * DESCRIPTION - * this function decodes relative humidity value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes relative humidity value + * + *@param s string to display + *@param value value to decode +*/ static void decode_relhum_meas_value(gchar *s, guint16 value) { @@ -1721,18 +1512,12 @@ decode_relhum_meas_value(gchar *s, guint16 value) return; } /*decode_relhum_meas_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_relhum_meas_min_value - * DESCRIPTION - * this function decodes minimum relative humidity value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes minimum relative humidity value + * + *@param s string to display + *@param value value to decode +*/ static void decode_relhum_meas_min_value(gchar *s, guint16 value) { @@ -1744,18 +1529,12 @@ decode_relhum_meas_min_value(gchar *s, guint16 value) return; } /*decode_relhum_meas_min_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_relhum_meas_max_value - * DESCRIPTION - * this function decodes maximum relative humidity value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes maximum relative humidity value + * + *@param s string to display + *@param value value to decode +*/ static void decode_relhum_meas_max_value(gchar *s, guint16 value) { @@ -1767,18 +1546,12 @@ decode_relhum_meas_max_value(gchar *s, guint16 value) return; } /*decode_relhum_meas_max_value*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_relhum_meas_tolerance - * DESCRIPTION - * this function decodes tolerance value - * PARAMETERS - * guint *s - string to display - * guint16 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes tolerance value + * + *@param s string to display + *@param value value to decode +*/ static void decode_relhum_meas_tolerance(gchar *s, guint16 value) { @@ -1790,18 +1563,10 @@ decode_relhum_meas_tolerance(gchar *s, guint16 value) return; } /*decode_relhum_meas_tolerance*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_relhum_meas - * DESCRIPTION - * this function registers the ZCL Relative Humidity Measurement dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Relative Humidity Measurement dissector + * +*/ void proto_register_zbee_zcl_relhum_meas(void) { @@ -1838,17 +1603,10 @@ proto_register_zbee_zcl_relhum_meas(void) } /*proto_register_zbee_zcl_relhum_meas*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_relhum_meas - * DESCRIPTION - * Hands off the ZCL Relative Humidity Measurement dissector. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Hands off the ZCL Relative Humidity Measurement dissector. + * +*/ void proto_reg_handoff_zbee_zcl_relhum_meas(void) { diff --git a/epan/dissectors/packet-zbee-zcl-misc.c b/epan/dissectors/packet-zbee-zcl-misc.c index 7232a4c69c..eb54d1cbed 100644 --- a/epan/dissectors/packet-zbee-zcl-misc.c +++ b/epan/dissectors/packet-zbee-zcl-misc.c @@ -248,19 +248,13 @@ static int dissect_zcl_thermostat_schedule(proto_tree *tree, tvbuff_t *tvb, gui static void dissect_zcl_thermostat_schedule_days(proto_tree *tree, tvbuff_t *tvb, guint offset); static void dissect_zcl_thermostat_schedule_mode(proto_tree *tree, tvbuff_t *tvb, guint offset); -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_thermostat_schedule_days - * DESCRIPTION - * Helper function to dissect a Thermostat scheduling days bitmask. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint offset - payload offset of the ZoneStatus value. - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper function to dissect a Thermostat scheduling days bitmask. + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset payload offset of the ZoneStatus value. +*/ static void dissect_zcl_thermostat_schedule_days(proto_tree *tree, tvbuff_t *tvb, guint offset) { @@ -282,19 +276,13 @@ dissect_zcl_thermostat_schedule_days(proto_tree *tree, tvbuff_t *tvb, guint offs } /* dissect_zcl_thermostat_schedule_days */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_thermostat_schedule_mode - * DESCRIPTION - * Helper function to dissect a Thermostat scheduling mode bitmask. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint offset - payload offset of the ZoneStatus value. - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper function to dissect a Thermostat scheduling mode bitmask. + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset payload offset of the ZoneStatus value. +*/ static void dissect_zcl_thermostat_schedule_mode(proto_tree *tree, tvbuff_t *tvb, guint offset) { @@ -309,21 +297,14 @@ dissect_zcl_thermostat_schedule_mode(proto_tree *tree, tvbuff_t *tvb, guint offs ett_zbee_zcl_thermostat_schedule_mode, thermostat_schedule_modes, ENC_NA); } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_thermostat_cmd_schedule - * DESCRIPTION - * Helper function to dissect a Thermostat schedule, which has - * a common format in both the Set Weekly Schedule, and Get - * Weekly Schedule Response commands. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint offset - payload offset of the ZoneStatus value. - * RETURNS - * int - length of parsed data. - *--------------------------------------------------------------- - */ +/** + *Helper function to dissect a Thermostat schedule, which has + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset payload offset of the ZoneStatus value. + *@return length of parsed data. +*/ static int dissect_zcl_thermostat_schedule(proto_tree *tree, tvbuff_t *tvb, guint offset) { @@ -370,20 +351,15 @@ dissect_zcl_thermostat_schedule(proto_tree *tree, tvbuff_t *tvb, guint offset) return (offset - start); } /* dissect_zcl_thermostat_cmd_schedule */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_thermostat - * DESCRIPTION - * ZigBee ZCL Thermostat cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * void *data - pointer to ZCL packet structure. - * RETURNS - * int - length of parsed data. - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Thermostat cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. + *@param data pointer to ZCL packet structure. + *@return length of parsed data. +*/ static int dissect_zbee_zcl_thermostat(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { @@ -466,22 +442,15 @@ dissect_zbee_zcl_thermostat(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, return tvb_captured_length(tvb); } /* dissect_zbee_zcl_thermostat */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_thermostat_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_thermostat_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -493,17 +462,10 @@ dissect_zcl_thermostat_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, } } /*dissect_zcl_thermostat_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_ias_zone - * DESCRIPTION - * ZigBee ZCL IAS Zone cluste protocol registration. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL IAS Zone cluste protocol registration. + * +*/ void proto_register_zbee_zcl_thermostat(void) { @@ -608,17 +570,10 @@ proto_register_zbee_zcl_thermostat(void) register_dissector(ZBEE_PROTOABBREV_ZCL_THERMOSTAT, dissect_zbee_zcl_thermostat, proto_zbee_zcl_thermostat); } /*proto_register_zbee_zcl_thermostat*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_thermostat - * DESCRIPTION - * Hands off the ZCL Thermostat dissector. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Hands off the ZCL Thermostat dissector. + * +*/ void proto_reg_handoff_zbee_zcl_thermostat(void) { @@ -811,19 +766,13 @@ static void dissect_zcl_ias_zone_attr_data (proto_tree *tree, tvbuff_t *tvb, gu /* ZoneStatus bitmask helper */ static void dissect_zcl_ias_zone_status (proto_tree *tree, tvbuff_t *tvb, guint offset); -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ias_zone_status - * DESCRIPTION - * Helper function to dissect the IAS ZoneStatus bitmask. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint offset - payload offset of the ZoneStatus value. - * RETURNS - * int - length of parsed data. - *--------------------------------------------------------------- - */ +/** + *Helper function to dissect the IAS ZoneStatus bitmask. + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset payload offset of the ZoneStatus value. +*/ static void dissect_zcl_ias_zone_status(proto_tree *tree, tvbuff_t *tvb, guint offset) { @@ -843,20 +792,15 @@ dissect_zcl_ias_zone_status(proto_tree *tree, tvbuff_t *tvb, guint offset) } /* dissect_zcl_ias_zone_status */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_ias_zone - * DESCRIPTION - * ZigBee ZCL IAS Zone cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * void *data - pointer to ZCL packet structure. - * RETURNS - * int - length of parsed data. - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL IAS Zone cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. + *@param data pointer to ZCL packet structure. + *@return length of parsed data. +*/ static int dissect_zbee_zcl_ias_zone(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data) { @@ -925,22 +869,15 @@ dissect_zbee_zcl_ias_zone(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, v return tvb_reported_length(tvb); } /* dissect_zbee_zcl_ias_zone */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ias_zone_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_ias_zone_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -968,17 +905,10 @@ dissect_zcl_ias_zone_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, g } } /*dissect_zcl_ias_zone_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_ias_zone - * DESCRIPTION - * Hands off the ZCL IAS Zone dissector. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Hands off the ZCL IAS Zone dissector. + * +*/ void proto_reg_handoff_zbee_zcl_ias_zone(void) { @@ -998,17 +928,10 @@ proto_reg_handoff_zbee_zcl_ias_zone(void) ); } /*proto_reg_handoff_zbee_zcl_ias_zone*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_ias_zone - * DESCRIPTION - * ZigBee ZCL IAS Zone cluste protocol registration. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL IAS Zone cluste protocol registration. + * +*/ void proto_register_zbee_zcl_ias_zone(void) { diff --git a/epan/dissectors/packet-zbee-zcl-se.c b/epan/dissectors/packet-zbee-zcl-se.c index fcb936bc24..9c8394339f 100644 --- a/epan/dissectors/packet-zbee-zcl-se.c +++ b/epan/dissectors/packet-zbee-zcl-se.c @@ -196,22 +196,15 @@ static const value_string zbee_zcl_msg_ctrl_importance_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_msg_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_msg_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -230,19 +223,13 @@ dissect_zcl_msg_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint1 } } /*dissect_zcl_ias_zone_attr_data*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_msg - * DESCRIPTION - * ZigBee ZCL Messaging cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Messaging cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_msg(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { @@ -335,19 +322,13 @@ dissect_zbee_zcl_msg(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* return tvb_captured_length(tvb); } /*dissect_zbee_zcl_msg*/ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_msg_display - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_msg_display(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -402,19 +383,13 @@ dissect_zcl_msg_display(tvbuff_t *tvb, proto_tree *tree, guint *offset) } /*dissect_zcl_msg_display*/ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_msg_cancel - * DESCRIPTION - * This function manages the Cancel Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Cancel Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_msg_cancel(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint *offset) { @@ -436,19 +411,13 @@ dissect_zcl_msg_cancel(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guin } /* dissect_zcl_msg_cancel */ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_msg_cancel_all - * DESCRIPTION - * Send Cancel All command - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Send Cancel All command + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_msg_cancel_all(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -462,19 +431,13 @@ dissect_zcl_msg_cancel_all(tvbuff_t *tvb, proto_tree *tree, guint *offset) } /* dissect_zcl_msg_cancel_all */ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_msg_get_cancel - * DESCRIPTION - * Send Cancel All command - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *Send Cancel All command + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_msg_get_cancel(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -489,19 +452,13 @@ dissect_zcl_msg_get_cancel(tvbuff_t *tvb, proto_tree *tree, guint *offset) } /* dissect_zcl_msg_get_cancel */ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_msg_confirm - * DESCRIPTION - * This function manages the Message Confirmation payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Message Confirmation payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_msg_confirm(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -539,16 +496,10 @@ dissect_zcl_msg_confirm(tvbuff_t *tvb, proto_tree *tree, guint *offset) } /* dissect_zcl_msg_confirm */ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_zcl_msg_duration - * DESCRIPTION - * this function decodes duration in minute type variable - * PARAMETERS - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes duration in minute type variable + * +*/ static void decode_zcl_msg_duration(gchar *s, guint16 value) { @@ -559,19 +510,12 @@ decode_zcl_msg_duration(gchar *s, guint16 value) return; } /*decode_zcl_msg_duration*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_zcl_msg_start_time - * DESCRIPTION - * this function decodes start time, with peculiarity case for - * messaging specifications. - * PARAMETERS - * guint *s - string to display - * guint32 value - value to decode - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes start time, with peculiarity case for + * + *@param s string to display + *@param value value to decode +*/ static void decode_zcl_msg_start_time(gchar *s, guint32 value) { @@ -586,18 +530,10 @@ decode_zcl_msg_start_time(gchar *s, guint32 value) } } /* decode_zcl_msg_start_time */ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_msg - * DESCRIPTION - * this function registers the ZCL Messaging dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Messaging dissector + * +*/ void proto_register_zbee_zcl_msg(void) { @@ -726,17 +662,10 @@ proto_register_zbee_zcl_msg(void) register_dissector(ZBEE_PROTOABBREV_ZCL_MSG, dissect_zbee_zcl_msg, proto_zbee_zcl_msg); } /*proto_register_zbee_zcl_msg*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_msg - * DESCRIPTION - * Hands off the Zcl Messaging dissector. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Hands off the Zcl Messaging dissector. + * +*/ void proto_reg_handoff_zbee_zcl_msg(void) { @@ -915,22 +844,15 @@ static const value_string zbee_zcl_tun_status_names[] = { /* Function Bodies */ /*************************/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_attr_data - * DESCRIPTION - * this function is called by ZCL foundation dissector in order to decode - * specific cluster attributes data. - * PARAMETERS - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint *offset - pointer to buffer offset - * guint16 attr_id - attribute identifier - * guint data_type - attribute data type - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ static void dissect_zcl_tun_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { @@ -953,19 +875,13 @@ dissect_zcl_tun_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint1 } } /*dissect_zcl_ias_zone_attr_data*/ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_request_tunnel - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_request_tunnel(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -982,19 +898,13 @@ dissect_zcl_tun_request_tunnel(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += 2; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_close_tunnel - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_close_tunnel(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1002,19 +912,13 @@ dissect_zcl_tun_close_tunnel(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += 2; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_transfer_data - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_transfer_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1028,19 +932,13 @@ dissect_zcl_tun_transfer_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += length; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_transfer_data_error - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_transfer_data_error(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1051,19 +949,13 @@ dissect_zcl_tun_transfer_data_error(tvbuff_t *tvb, proto_tree *tree, guint *offs *offset += 1; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_ack_transfer_data - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_ack_transfer_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1074,19 +966,13 @@ dissect_zcl_tun_ack_transfer_data(tvbuff_t *tvb, proto_tree *tree, guint *offset *offset += 2; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_ready_data - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_ready_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1097,19 +983,13 @@ dissect_zcl_tun_ready_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += 2; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_get_supported - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_get_supported(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1117,19 +997,13 @@ dissect_zcl_tun_get_supported(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += 2; } - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_request_tunnel_rsp - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_request_tunnel_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1143,19 +1017,13 @@ dissect_zcl_tun_request_tunnel_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offse *offset += 2; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_get_supported_rsp - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_get_supported_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1182,19 +1050,13 @@ dissect_zcl_tun_get_supported_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset } } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_tun_closure_notify - * DESCRIPTION - * This function manages the Display Message payload - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_tun_closure_notify(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1202,19 +1064,13 @@ dissect_zcl_tun_closure_notify(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += 2; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_tun - * DESCRIPTION - * ZigBee ZCL Messaging cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Messaging cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_tun(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { @@ -1335,18 +1191,10 @@ dissect_zbee_zcl_tun(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* return tvb_captured_length(tvb); } /*dissect_zbee_zcl_tun*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_tun - * DESCRIPTION - * this function registers the ZCL Messaging dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Messaging dissector + * +*/ void proto_register_zbee_zcl_tun(void) { @@ -1437,17 +1285,10 @@ proto_register_zbee_zcl_tun(void) } /* proto_register_zbee_zcl_tun */ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_tun - * DESCRIPTION - * Hands off the Zcl Messaging dissector. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Hands off the Zcl Messaging dissector. + * +*/ void proto_reg_handoff_zbee_zcl_tun(void) { @@ -1608,19 +1449,13 @@ static const value_string zbee_zcl_ke_status_names[] = { /*************************/ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ke_suite1_certificate - * DESCRIPTION - * This function dissects the Suite 1 Certificate - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function dissects the Suite 1 Certificate + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_ke_suite1_certificate(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1638,19 +1473,13 @@ dissect_zcl_ke_suite1_certificate(tvbuff_t *tvb, proto_tree *tree, guint *offset } /*dissect_zcl_ke_suite1_certificate*/ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ke_suite2_certificate - * DESCRIPTION - * This function dissects the Suite 2 Certificate - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function dissects the Suite 2 Certificate + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_ke_suite2_certificate(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1706,19 +1535,13 @@ dissect_zcl_ke_suite2_certificate(tvbuff_t *tvb, proto_tree *tree, guint *offset } /*dissect_zcl_ke_suite2_certificate*/ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ke_initiate_req - * DESCRIPTION - * This function manages the Initiate Key Establishment message - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function manages the Initiate Key Establishment message + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_ke_initiate(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1754,19 +1577,13 @@ dissect_zcl_ke_initiate(tvbuff_t *tvb, proto_tree *tree, guint *offset) } } /* dissect_zcl_ke_initiate */ - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ke_ephemeral_qeu - * DESCRIPTION - * This function dissects the Ephemeral Data QEU - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function dissects the Ephemeral Data QEU + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static int dissect_zcl_ke_ephemeral_qeu(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1780,19 +1597,13 @@ dissect_zcl_ke_ephemeral_qeu(tvbuff_t *tvb, proto_tree *tree, guint *offset) return tvb_captured_length(tvb); } - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ke_ephemeral_qev - * DESCRIPTION - * This function dissects the Ephemeral Data QEV - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function dissects the Ephemeral Data QEV + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static int dissect_zcl_ke_ephemeral_qev(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1806,19 +1617,13 @@ dissect_zcl_ke_ephemeral_qev(tvbuff_t *tvb, proto_tree *tree, guint *offset) return tvb_captured_length(tvb); } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ke_confirm_macu - * DESCRIPTION - * This function dissects the Confirm MACU - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function dissects the Confirm MACU + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static int dissect_zcl_ke_confirm_macu(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1827,19 +1632,13 @@ dissect_zcl_ke_confirm_macu(tvbuff_t *tvb, proto_tree *tree, guint *offset) return tvb_captured_length(tvb); } - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ke_confirm_macv - * DESCRIPTION - * This function dissects the Confirm MACV - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function dissects the Confirm MACV + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static int dissect_zcl_ke_confirm_macv(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1848,19 +1647,13 @@ dissect_zcl_ke_confirm_macv(tvbuff_t *tvb, proto_tree *tree, guint *offset) return tvb_captured_length(tvb); } - /*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_ke_terminate - * DESCRIPTION - * This function dissects the Terminate Key Establishment message - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * offset - offset - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function dissects the Terminate Key Establishment message + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_ke_terminate(tvbuff_t *tvb, proto_tree *tree, guint *offset) { @@ -1874,19 +1667,13 @@ dissect_zcl_ke_terminate(tvbuff_t *tvb, proto_tree *tree, guint *offset) *offset += 2; } -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl_ke - * DESCRIPTION - * ZigBee ZCL Key Establishment cluster dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL Key Establishment cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static int dissect_zbee_zcl_ke(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { @@ -1975,18 +1762,10 @@ dissect_zbee_zcl_ke(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* d } /*dissect_zbee_zcl_ke*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl_ke - * DESCRIPTION - * this function registers the ZCL Messaging dissector - * and all its information. - * PARAMETERS - * none - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function registers the ZCL Messaging dissector + * +*/ void proto_register_zbee_zcl_ke(void) { @@ -2105,17 +1884,10 @@ proto_register_zbee_zcl_ke(void) register_dissector(ZBEE_PROTOABBREV_ZCL_KE, dissect_zbee_zcl_ke, proto_zbee_zcl_ke); } /*proto_register_zbee_zcl_ke*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl_ke - * DESCRIPTION - * Hands off the Zcl Key Establishment dissector. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Hands off the Zcl Key Establishment dissector. + * +*/ void proto_reg_handoff_zbee_zcl_ke(void) { diff --git a/epan/dissectors/packet-zbee-zcl.c b/epan/dissectors/packet-zbee-zcl.c index 13ee8b8ea5..6daac375ab 100644 --- a/epan/dissectors/packet-zbee-zcl.c +++ b/epan/dissectors/packet-zbee-zcl.c @@ -759,20 +759,14 @@ static const value_string zbee_zcl_dis_names[] = { { 0, NULL } }; -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zbee_zcl - * DESCRIPTION - * ZigBee Cluster Library dissector for wireshark. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_into *pinfo - pointer to packet information fields. - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * void *data - raw packet private data. - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *ZigBee Cluster Library dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields. + *@param tree pointer to data tree wireshark uses to display packet. + *@param data raw packet private data. +*/ static int dissect_zbee_zcl(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { tvbuff_t *payload_tvb; @@ -961,21 +955,15 @@ static int dissect_zbee_zcl(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, return tvb_captured_length(tvb); } /* dissect_zbee_zcl */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_read_attr - * DESCRIPTION - * Helper dissector for ZCL Read Attributes and - * Write Attributes No Response commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * RETURNS - * guint - offset after command dissection. - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Read Attributes and + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer from caller. + *@param cluster_id cluster id +*/ void dissect_zcl_read_attr(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { guint tvb_len; @@ -989,20 +977,15 @@ void dissect_zcl_read_attr(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tr return; } /* dissect_zcl_read_attr */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_read_attr_resp - * DESCRIPTION - * Helper dissector for ZCL Read Attributes Response command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * RETURNS - * guint - offset after command dissection. - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Read Attributes Response command. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller + *@param cluster_id cluster id +*/ void dissect_zcl_read_attr_resp(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { proto_tree *sub_tree; @@ -1032,20 +1015,15 @@ void dissect_zcl_read_attr_resp(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tre } } /* dissect_zcl_read_attr_resp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_write_attr - * DESCRIPTION - * Helper dissector for ZCL Report Attribute commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * RETURNS - * guint - offset after command dissection. - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Report Attribute commands. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller + *@param cluster_id cluster id +*/ void dissect_zcl_write_attr(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { proto_tree *sub_tree; @@ -1070,20 +1048,15 @@ void dissect_zcl_write_attr(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *t } } /* dissect_zcl_write_attr */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_write_attr_resp - * DESCRIPTION - * Helper dissector for ZCL Write Attribute Response command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * RETURNS - * guint - offset after command dissection. - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Write Attribute Response command. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller + *@param cluster_id cluster id +*/ static void dissect_zcl_write_attr_resp(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { proto_tree *sub_tree; @@ -1109,18 +1082,14 @@ static void dissect_zcl_write_attr_resp(tvbuff_t *tvb, packet_info *pinfo _U_, p } /* dissect_zcl_write_attr_resp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_read_report_config_resp - * DESCRIPTION - * Helper dissector for ZCL Report Attribute commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Report Attribute commands. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_read_report_config_resp(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { @@ -1180,18 +1149,15 @@ static void dissect_zcl_read_report_config_resp(tvbuff_t *tvb, packet_info *pinf } /* dissect_zcl_read_report_config_resp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_config_report - * DESCRIPTION - * Helper dissector for ZCL Report Attribute commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Report Attribute commands. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller + *@param cluster_id cluster id +*/ static void dissect_zcl_config_report(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { proto_tree *sub_tree; @@ -1244,20 +1210,15 @@ static void dissect_zcl_config_report(tvbuff_t *tvb, packet_info *pinfo _U_, pro } /* dissect_zcl_config_report */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_config_report_resp - * DESCRIPTION - * Helper dissector for ZCL Report Attribute commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * RETURNS - * guint - offset after command dissection. - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Report Attribute commands. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller + *@param cluster_id cluster id +*/ static void dissect_zcl_config_report_resp(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { @@ -1285,20 +1246,15 @@ static void dissect_zcl_config_report_resp(tvbuff_t *tvb, packet_info *pinfo _U_ } } /* dissect_zcl_config_report_resp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_read_report_config - * DESCRIPTION - * Helper dissector for ZCL Read Report Configuration command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * RETURNS - * guint - offset after command dissection. - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Read Report Configuration command. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller + *@param cluster_id cluster id +*/ static void dissect_zcl_read_report_config(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { @@ -1323,21 +1279,16 @@ static void dissect_zcl_read_report_config(tvbuff_t *tvb, packet_info *pinfo _U_ } /* dissect_zcl_read_report_config */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_default_resp - * DESCRIPTION - * Helper dissector for ZCL Default Response command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * dir - direction - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Default Response command. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller. + *@param cluster_id cluster id. + *@param dir direction. +*/ static void dissect_zcl_default_resp(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id, guint8 dir) { @@ -1359,20 +1310,14 @@ static void dissect_zcl_default_resp(tvbuff_t *tvb, packet_info *pinfo _U_, prot dissect_zcl_attr_uint8(tvb, tree, offset, &hf_zbee_zcl_attr_status); } /* dissect_zcl_default_resp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_discover_attr - * DESCRIPTION - * Helper dissector for ZCL Discover Attributes command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Discover Attributes command. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ static void dissect_zcl_discover_attr(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset) { /* Dissect the starting attribute identifier */ @@ -1386,20 +1331,15 @@ static void dissect_zcl_discover_attr(tvbuff_t *tvb, packet_info *pinfo _U_, pro } /* dissect_zcl_discover_attr */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_discover_attr_resp - * DESCRIPTION - * Helper dissector for ZCL Discover Attributes command. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - pointer to offset from caller - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Discover Attributes command. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset pointer to offset from caller + *@param cluster_id cluster id +*/ static void dissect_zcl_discover_attr_resp(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id) { @@ -1428,21 +1368,13 @@ static void dissect_zcl_discover_attr_resp(tvbuff_t *tvb, packet_info *pinfo _U_ } /* dissect_zcl_discover_attr_resp */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_attr_id - * DESCRIPTION - * Dissects Attribute ID field. This could be done with the - * dissect_zcl_attr_uint16 function, but we leave it separate - * so we can dissect the attr_id with a hash in the future. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - offset into the tvb to begin dissection. - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Dissects Attribute ID field. This could be done with the + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset into the tvb to begin dissection. +*/ static void dissect_zcl_attr_id(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint16 cluster_id) { zbee_zcl_cluster_desc *desc; @@ -1457,19 +1389,13 @@ static void dissect_zcl_attr_id(tvbuff_t *tvb, proto_tree *tree, guint *offset, *offset += 2; } /* dissect_zcl_attr_id */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_attr_data_type_val - * DESCRIPTION - * Helper dissector for ZCL Attribute commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - offset into the tvb to begin dissection. - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Attribute commands. + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset into the tvb to begin dissection. +*/ static void dissect_zcl_attr_data_type_val(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint16 attr_id, guint16 cluster_id) { zbee_zcl_cluster_desc *desc; @@ -1487,21 +1413,16 @@ static void dissect_zcl_attr_data_type_val(tvbuff_t *tvb, proto_tree *tree, guin } /* dissect_zcl_attr_data_type_val */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_attr_data_general - * DESCRIPTION - * Helper dissector for ZCL Attribute commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - offset into the tvb to begin dissection. - * attr_id - attribute identification - * data_type - type of data - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Attribute commands. + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset into the tvb to begin dissection. + *@param attr_id attribute identification + *@param data_type type of data + *@param cluster_id cluster id +*/ static void dissect_zcl_attr_data_general(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint16 attr_id, guint data_type, guint16 cluster_id) { zbee_zcl_cluster_desc *desc; @@ -1516,21 +1437,13 @@ static void dissect_zcl_attr_data_general(tvbuff_t *tvb, proto_tree *tree, guint } /*dissect_zcl_attr_data_general*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_attr_data - * DESCRIPTION - * Dissects the various types of ZCL attribute data. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * packet_info *pinfo - pointer to packet information fields - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - offset into the tvb to begin dissection. - * data_type - the type of ZCL data in the packet buffer - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Dissects the various types of ZCL attribute data. + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset into the tvb to begin dissection. +*/ void dissect_zcl_attr_data(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint data_type) { guint attr_uint; @@ -1943,20 +1856,15 @@ void dissect_zcl_attr_data(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint } /* dissect_zcl_attr_data */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_attr_uint8 - * DESCRIPTION - * Helper dissector for ZCL Attribute commands. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - offset into the tvb to begin dissection. - * hf_zbee_zcl - pointer to header field index - * RETURNS - * guint - dissected data - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL Attribute commands. + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset into the tvb to begin dissection. + *@param hf_zbee_zcl pointer to header field index + *@return dissected data +*/ static guint dissect_zcl_attr_uint8(tvbuff_t *tvb, proto_tree *tree, guint *offset, int *hf_zbee_zcl) { guint attr_uint; @@ -1968,21 +1876,15 @@ static guint dissect_zcl_attr_uint8(tvbuff_t *tvb, proto_tree *tree, guint *offs return attr_uint; } /* dissect_zcl_attr_uint8 */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_array_type - * DESCRIPTION - * Helper dissector for ZCL attribute array type. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - offset into the tvb to begin dissection. - * elements_type - element type - * elements_num - elements number - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL attribute array type. + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset into the tvb to begin dissection. + *@param elements_type element type + *@param elements_num elements number +*/ static void dissect_zcl_array_type(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint8 elements_type, guint16 elements_num) { @@ -2009,21 +1911,15 @@ dissect_zcl_array_type(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint8 el } } /* dissect_zcl_array_type */ -/*FUNCTION:------------------------------------------------------ - * NAME - * dissect_zcl_set_type - * DESCRIPTION - * Helper dissector for ZCL attribute set and bag types. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * proto_tree *tree - pointer to data tree wireshark uses to display packet. - * offset - offset into the tvb to begin dissection. - * elements_type - element type - * elements_num - elements number - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper dissector for ZCL attribute set and bag types. + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree wireshark uses to display packet. + *@param offset into the tvb to begin dissection. + *@param elements_type element type + *@param elements_num elements number +*/ static void dissect_zcl_set_type(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint8 elements_type, guint16 elements_num) { @@ -2050,20 +1946,14 @@ dissect_zcl_set_type(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint8 elem } } /* dissect_zcl_set_type */ -/*FUNCTION:------------------------------------------------------ - * NAME - * zcl_dump_data - * DESCRIPTION - * Helper functions dumps any remaining data into the data dissector. - * PARAMETERS - * tvbuff_t *tvb - pointer to buffer containing raw packet. - * guint offset - offset after parsing last item. - * packet_info *pinfo - packet information structure. - * proto_tree *tree - pointer to data tree Wireshark uses to display packet. - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Helper functions dumps any remaining data into the data dissector. + * + *@param tvb pointer to buffer containing raw packet. + *@param offset offset after parsing last item. + *@param pinfo packet information structure. + *@param tree pointer to data tree Wireshark uses to display packet. +*/ static void zcl_dump_data(tvbuff_t *tvb, guint offset, packet_info *pinfo, proto_tree *tree) { proto_tree *root = proto_tree_get_root(tree); @@ -2078,49 +1968,30 @@ static void zcl_dump_data(tvbuff_t *tvb, guint offset, packet_info *pinfo, proto return; } /* zcl_dump_data */ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_zcl_time_in_seconds - * DESCRIPTION - * this function decodes second time type variable - * PARAMETERS - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes second time type variable + * +*/ void decode_zcl_time_in_seconds(gchar *s, guint16 value) { g_snprintf(s, ITEM_LABEL_LENGTH, "%d seconds", value); return; } /* decode_zcl_time_in_seconds*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * decode_zcl_time_in_minutes - * DESCRIPTION - * this function decodes minute time type variable - * PARAMETERS - * RETURNS - * none - *--------------------------------------------------------------- - */ +/** + *This function decodes minute time type variable + * +*/ void decode_zcl_time_in_minutes(gchar *s, guint16 value) { g_snprintf(s, ITEM_LABEL_LENGTH, "%d minutes", value); return; } /*decode_zcl_time_in_minutes*/ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_register_zbee_zcl - * DESCRIPTION - * ZigBee ZCL protocol registration routine. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *ZigBee ZCL protocol registration routine. + * +*/ void proto_register_zbee_zcl(void) { guint i, j; @@ -2405,17 +2276,10 @@ void proto_register_zbee_zcl(void) register_dissector(ZBEE_PROTOABBREV_ZCL, dissect_zbee_zcl, proto_zbee_zcl); } /* proto_register_zbee_zcl */ -/*FUNCTION:------------------------------------------------------ - * NAME - * proto_reg_handoff_zbee_zcl - * DESCRIPTION - * Finds the dissectors used in this module. - * PARAMETERS - * none - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Finds the dissectors used in this module. + * +*/ void proto_reg_handoff_zbee_zcl(void) { dissector_handle_t zbee_zcl_handle; @@ -2439,23 +2303,17 @@ void proto_reg_handoff_zbee_zcl(void) } /* proto_reg_handoff_zbee_zcl */ -/*FUNCTION:------------------------------------------------------ - * NAME - * zbee_zcl_init_cluster - * DESCRIPTION - * Register the specific cluster. - * PARAMETERS - * proto - dissector proto - * ett - ett proto (not used at the moment) - * cluster_id - cluster id - * hf_attr_id - cluster-specific attribute ID field. - * hf_cmd_rx_id - cluster-specific client-to-server command ID field, or -1. - * hf_cmd_tx_id - cluster-specific server-to-client command ID field, or -1. - * fn_attr_data - specific cluster attribute data decode function - * RETURNS - * void - *--------------------------------------------------------------- - */ +/** + *Register the specific cluster. + * + *@param proto dissector + *@param ett proto (not used at the moment) + *@param cluster_id cluster identification + *@param hf_attr_id cluster-specific attribute ID field. + *@param hf_cmd_rx_id cluster-specific client-to-server command ID field, or -1. + *@param hf_cmd_tx_id cluster-specific server-to-client command ID field, or -1. + *@param fn_attr_data specific cluster attribute data decode function +*/ void zbee_zcl_init_cluster(int proto, gint ett, guint16 cluster_id, int hf_attr_id, int hf_cmd_rx_id, int hf_cmd_tx_id, zbee_zcl_fn_attr_data fn_attr_data) { @@ -2477,17 +2335,12 @@ zbee_zcl_init_cluster(int proto, gint ett, guint16 cluster_id, int hf_attr_id, i return; } -/*FUNCTION:------------------------------------------------------ - * NAME - * zbee_zcl_get_cluster_desc - * DESCRIPTION - * Retrieves the registered specific cluster descriptor. - * PARAMETERS - * cluster_id - cluster id - * RETURNS - * zbee_zcl_cluster_desc - cluster descriptor pointer - *--------------------------------------------------------------- - */ +/** + *Retrieves the registered specific cluster descriptor. + * + *@param cluster_id cluster identification + *@return cluster descriptor pointer +*/ zbee_zcl_cluster_desc *zbee_zcl_get_cluster_desc(guint16 cluster_id) {