Skip to content

Commit 663fd3e

Browse files
Juha Heiskanenjuhhei01
authored andcommitted
Fixed missing doxygen tags.
Change-Id: I6def7287c83f1a888c5a016d018d4050913d3e50
1 parent b9f7bf4 commit 663fd3e

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

nanostack/mac_common_defines.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,10 @@ typedef struct mlme_security_s {
6767
uint8_t Keysource[8]; /**< Key source */
6868
} mlme_security_t;
6969

70-
#define MAC_HEADER_VENDOR_SPESIFIC_IE_ID 0x00
71-
#define MAC_HEADER_ASSIGNED_EXTERNAL_ORG_IE_ID 0x2a
72-
#define MAC_HEADER_TERMINATION1_IE_ID 0x7e
73-
#define MAC_HEADER_TERMINATION2_IE_ID 0x7f
70+
#define MAC_HEADER_VENDOR_SPESIFIC_IE_ID 0x00 /**< Vendor specific Header IE element */
71+
#define MAC_HEADER_ASSIGNED_EXTERNAL_ORG_IE_ID 0x2a /**< External organisation defined Header IE element */
72+
#define MAC_HEADER_TERMINATION1_IE_ID 0x7e /**< Header IE element termination when Payload element is following Header IE */
73+
#define MAC_HEADER_TERMINATION2_IE_ID 0x7f /**< Header IE element termination when no Payload element is following Header IE but normal payload is */
7474

7575

7676
/**
@@ -83,11 +83,11 @@ typedef struct mac_header_IE_s {
8383
uint8_t id; /**< Element ID */
8484
} mac_header_IE_t;
8585

86-
#define MAC_PAYLOAD_IE_ESDU_GROUP_ID 0x00
87-
#define MAC_PAYLOAD_MLME_IE_GROUP_ID 0x01
88-
#define MAC_PAYLOAD_VENDOR_IE_GROUP_ID 0x02
89-
#define MAC_PAYLOAD_MPX_IE_GROUP_ID 0x03
90-
#define MAC_PAYLOAD_TERMINATION_IE_GROUP_ID 0x0f
86+
#define MAC_PAYLOAD_IE_ESDU_GROUP_ID 0x00 /**< Encapsulated Service Data Unit (ESDU) Payload IE element's */
87+
#define MAC_PAYLOAD_MLME_IE_GROUP_ID 0x01 /**< MLME nested Payload IE element's */
88+
#define MAC_PAYLOAD_VENDOR_IE_GROUP_ID 0x02 /**< Vendor specific nested Payload IE element's */
89+
#define MAC_PAYLOAD_MPX_IE_GROUP_ID 0x03 /**< MPX Payload IE element, IEEE 802.15.9 defined */
90+
#define MAC_PAYLOAD_TERMINATION_IE_GROUP_ID 0x0f /**< Payload IE element terminator. Mandatory when normal payload is coming after IE element part */
9191

9292
/**
9393
* @brief struct mac_header_IE_t Mac Payload information element structure for parsing or write operation

nanostack/mac_mcps.h

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ typedef struct mcps_data_conf_s {
5959
} mcps_data_conf_t;
6060

6161

62+
/**
63+
* @brief struct mcps_data_conf_payload_t Data confirmatio IE extension list and payload from enhanced ACK
64+
*
65+
*/
6266
typedef struct mcps_data_conf_payload_s {
6367
uint8_t *headerIeList; /**< Header information IE's list without terminator*/
6468
uint8_t *payloadIeList; /**< Payload information IE's list without terminator*/
@@ -92,7 +96,7 @@ typedef struct mcps_data_ind_s {
9296
/**
9397
* @brief struct mcps_data_ie_list_t MCPS data Information element list stucture
9498
*
95-
* Structure for IEEE 802.15.4-2015 MCPS data extension to Indication and confirmation
99+
* Structure for IEEE 802.15.4-2015 MCPS data extension to Indication
96100
*/
97101
typedef struct mcps_data_ie_list {
98102
uint8_t *headerIeList; /**< Header information IE's list without terminator*/
@@ -122,8 +126,8 @@ typedef struct ns_ie_iovec {
122126
typedef struct mcps_data_req_ie_list {
123127
ns_ie_iovec_t *headerIeVectorList; /**< Header IE element list */
124128
ns_ie_iovec_t *payloadIeVectorList; /**< Payload IE element list */
125-
uint16_t headerIovLength; /**< Header IE element list size, set 0 when no elements */
126-
uint16_t payloadIovLength; /**< Payload IE element list size, set 0 when no elements */
129+
uint16_t headerIovLength; /**< Header IE element list size, set 0 when no elements */
130+
uint16_t payloadIovLength; /**< Payload IE element list size, set 0 when no elements */
127131
} mcps_data_req_ie_list_t;
128132

129133

0 commit comments

Comments
 (0)