From 663fd3e8f3bf2b8f6a99a86323a755aa1cc1ee80 Mon Sep 17 00:00:00 2001 From: Juha Heiskanen Date: Thu, 18 Jan 2018 09:22:57 +0200 Subject: [PATCH] Fixed missing doxygen tags. Change-Id: I6def7287c83f1a888c5a016d018d4050913d3e50 --- nanostack/mac_common_defines.h | 18 +++++++++--------- nanostack/mac_mcps.h | 10 +++++++--- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/nanostack/mac_common_defines.h b/nanostack/mac_common_defines.h index 03849b7609f..95a4cc10d61 100644 --- a/nanostack/mac_common_defines.h +++ b/nanostack/mac_common_defines.h @@ -67,10 +67,10 @@ typedef struct mlme_security_s { uint8_t Keysource[8]; /**< Key source */ } mlme_security_t; -#define MAC_HEADER_VENDOR_SPESIFIC_IE_ID 0x00 -#define MAC_HEADER_ASSIGNED_EXTERNAL_ORG_IE_ID 0x2a -#define MAC_HEADER_TERMINATION1_IE_ID 0x7e -#define MAC_HEADER_TERMINATION2_IE_ID 0x7f +#define MAC_HEADER_VENDOR_SPESIFIC_IE_ID 0x00 /**< Vendor specific Header IE element */ +#define MAC_HEADER_ASSIGNED_EXTERNAL_ORG_IE_ID 0x2a /**< External organisation defined Header IE element */ +#define MAC_HEADER_TERMINATION1_IE_ID 0x7e /**< Header IE element termination when Payload element is following Header IE */ +#define MAC_HEADER_TERMINATION2_IE_ID 0x7f /**< Header IE element termination when no Payload element is following Header IE but normal payload is */ /** @@ -83,11 +83,11 @@ typedef struct mac_header_IE_s { uint8_t id; /**< Element ID */ } mac_header_IE_t; -#define MAC_PAYLOAD_IE_ESDU_GROUP_ID 0x00 -#define MAC_PAYLOAD_MLME_IE_GROUP_ID 0x01 -#define MAC_PAYLOAD_VENDOR_IE_GROUP_ID 0x02 -#define MAC_PAYLOAD_MPX_IE_GROUP_ID 0x03 -#define MAC_PAYLOAD_TERMINATION_IE_GROUP_ID 0x0f +#define MAC_PAYLOAD_IE_ESDU_GROUP_ID 0x00 /**< Encapsulated Service Data Unit (ESDU) Payload IE element's */ +#define MAC_PAYLOAD_MLME_IE_GROUP_ID 0x01 /**< MLME nested Payload IE element's */ +#define MAC_PAYLOAD_VENDOR_IE_GROUP_ID 0x02 /**< Vendor specific nested Payload IE element's */ +#define MAC_PAYLOAD_MPX_IE_GROUP_ID 0x03 /**< MPX Payload IE element, IEEE 802.15.9 defined */ +#define MAC_PAYLOAD_TERMINATION_IE_GROUP_ID 0x0f /**< Payload IE element terminator. Mandatory when normal payload is coming after IE element part */ /** * @brief struct mac_header_IE_t Mac Payload information element structure for parsing or write operation diff --git a/nanostack/mac_mcps.h b/nanostack/mac_mcps.h index ad8609172a8..5e6019f26af 100644 --- a/nanostack/mac_mcps.h +++ b/nanostack/mac_mcps.h @@ -59,6 +59,10 @@ typedef struct mcps_data_conf_s { } mcps_data_conf_t; +/** + * @brief struct mcps_data_conf_payload_t Data confirmatio IE extension list and payload from enhanced ACK + * + */ typedef struct mcps_data_conf_payload_s { uint8_t *headerIeList; /**< Header information IE's list without terminator*/ uint8_t *payloadIeList; /**< Payload information IE's list without terminator*/ @@ -92,7 +96,7 @@ typedef struct mcps_data_ind_s { /** * @brief struct mcps_data_ie_list_t MCPS data Information element list stucture * - * Structure for IEEE 802.15.4-2015 MCPS data extension to Indication and confirmation + * Structure for IEEE 802.15.4-2015 MCPS data extension to Indication */ typedef struct mcps_data_ie_list { uint8_t *headerIeList; /**< Header information IE's list without terminator*/ @@ -122,8 +126,8 @@ typedef struct ns_ie_iovec { typedef struct mcps_data_req_ie_list { ns_ie_iovec_t *headerIeVectorList; /**< Header IE element list */ ns_ie_iovec_t *payloadIeVectorList; /**< Payload IE element list */ - uint16_t headerIovLength; /**< Header IE element list size, set 0 when no elements */ - uint16_t payloadIovLength; /**< Payload IE element list size, set 0 when no elements */ + uint16_t headerIovLength; /**< Header IE element list size, set 0 when no elements */ + uint16_t payloadIovLength; /**< Payload IE element list size, set 0 when no elements */ } mcps_data_req_ie_list_t;