Better struct comment

This commit is contained in:
bit-cyber-fh
2024-03-28 15:58:15 +08:00
parent 16d1ad30a7
commit 8d72288675
15 changed files with 154 additions and 131 deletions
@@ -28,7 +28,7 @@
*/
/**
* @struct Coordinate
* @struct COORD
* @brief Structure for storing 3D coordinates.
*/
typedef struct
@@ -45,7 +45,7 @@
*/
/**
* @struct EulerAngles
* @struct EULERANGLES
* @brief Structure for standard quaternion
*/
typedef struct
@@ -32,7 +32,7 @@
#include "eulerangles.h"
/**
* @struct Quaternion
* @struct QUATERNION
* @brief Structure for standard quaternion
*/
typedef struct
@@ -33,7 +33,7 @@
/**************************** Type Definitions *******************************/
/**
* @struct LinklayerConfig
* @struct L2_CONFIG
* @brief A struct holds all linklayer initialization parameters
*/
typedef struct
@@ -50,7 +50,7 @@ typedef struct
} L2_CONFIG;
/**
* @struct LinklayerLogLocal
* @struct L2_LOG
* @brief A struct holds linklayer operating log
*/
typedef struct
@@ -84,7 +84,7 @@ typedef struct
} L2_LOG;
/**
* @struct LinklayerInst
* @struct L2_INST
* @brief A linklayer instance
*/
typedef struct
@@ -59,7 +59,8 @@
/**************************** Type Definitions *******************************/
/**
* @struct LinklayerRecord
* @struct L2_RCD
* @brief Linklayer recode buffer
*/
typedef struct
{
@@ -69,7 +70,7 @@ typedef struct
} L2_RCD;
/**
* @enum LinklayerTorType
* @enum L2_TOR_TYPE
*/
typedef enum
{
@@ -79,7 +80,7 @@ typedef enum
} L2_TOR_TYPE;
/**
* @enum LinkLayerNodeType
* @enum L2_NODE_TYPE
*/
typedef enum
{
@@ -90,7 +91,7 @@ typedef enum
} L2_NODE_TYPE;
/**
* @enum LinklayerNodeState
* @enum L2_NODE_STATE
*/
typedef enum
{
@@ -103,7 +104,7 @@ typedef enum
} L2_NODE_STATE;
/**
* @struct LinklayerNodeInfo
* @struct L2_NODE_INFO
* @brief Node information struct contains the detail node info which needed by the link layer.
*/
typedef struct
@@ -119,7 +120,7 @@ typedef struct
} L2_NODE_INFO;
/**
* @enum LinklayerEvent
* @enum L2_EVENT_TYPE
*/
typedef enum
{
@@ -138,7 +139,8 @@ typedef enum
} L2_EVENT_TYPE;
/**
* @struct LinklayerEvent
* @struct L2_EVENT
* @brief Linklayer event instance
*/
typedef struct
{
@@ -147,7 +149,7 @@ typedef struct
} L2_EVENT;
/**
* @enum LinklayerSlotType
* @enum L2_SLOT_TYPE
*/
typedef enum
{
@@ -160,7 +162,7 @@ typedef enum
} L2_SLOT_TYPE;
/**
* @enum LinklayerFrameType
* @enum L2_FRAME_TYPE
*/
typedef enum
{
@@ -172,7 +174,7 @@ typedef enum
} L2_FRAME_TYPE;
/**
* @enum LinklayerCRCType
* @enum L2_CRC_TYPE
*/
typedef enum
{
@@ -183,7 +185,8 @@ typedef enum
} L2_CRC_TYPE;
/**
* @struct LinklayerRoutineTableEntry
* @struct L2_RTNE_TABLE_ENTRY
* @brief Linklayer routine table entry
*/
typedef struct
{
@@ -194,7 +197,7 @@ typedef struct
} L2_RTNE_TABLE_ENTRY;
/**
* @enum LinklayerScanStage
* @enum SCAN_STAGE
*/
typedef enum
{
@@ -205,7 +208,8 @@ typedef enum
} SCAN_STAGE;
/**
* @struct LinklayerScanFSM
* @struct L2_SCAN_FSM
* @brief Linklayer scan process FSM instance
*/
typedef struct
{
@@ -222,7 +226,8 @@ typedef struct
} L2_SCAN_FSM;
/**
* @struct LinklayerServiceFSM
* @struct L2_SVC_FSM
* @brief Linklayer service process FSM
*/
typedef struct
{
@@ -238,7 +243,8 @@ typedef struct
} L2_SVC_FSM;
/**
* @struct LinklayerRoutineConfig
* @struct L2_RTNE_CONFIG
* @brief Linklayer routine table configuration
*/
typedef struct
{
@@ -38,9 +38,10 @@
/***************** Macros (Inline Functions) Definitions *********************/
/**************************** Type Definitions *******************************/
/**
* @struct NodeList_Entry
* @struct NODE_ENTRY
* @brief Linklayer discovered node list node entry
*/
typedef struct NODE_LIST_ENTRY
typedef struct
{
L2_NODE_INFO nodeInfo;
uint32_t ttlCnt;
@@ -31,7 +31,8 @@
/***************** Macros (Inline Functions) Definitions *********************/
/**************************** Type Definitions *******************************/
/**
* @struct LinklayerEvent
* @struct L2_SCHD_EVENT
* @brief Linklayer scheduled event descriptor
*/
typedef struct
{
@@ -45,7 +46,8 @@ typedef struct
} L2_SCHD_EVENT;
/**
* @struct L2 event
* @struct L2_SCHD_POOL
* @brief Linklayer schedule event pool instance
*/
typedef struct
{
@@ -56,7 +56,7 @@
/***************** Macros (Inline Functions) Definitions *********************/
/**************************** Type Definitions *******************************/
/**
* @enum PhysicalLayerFrameType
* @enum L1_FRAME_TYPE
*/
typedef enum
{
@@ -72,7 +72,8 @@ typedef enum
} L1_FRAME_TYPE;
/**
* @struct PhysicalLayerAntennaConfig
* @struct PHY_ANT_CONFIG
* @brief PhysicalLayer antenna config
*/
typedef struct
{
@@ -113,7 +114,8 @@ typedef struct
} PHY_ANT_CONFIG;
/**
* @struct PhysicalLayerAntennaAngle
* @struct PHY_ANT_ANGLE
* @brief Describe the PhysicalLayer antenna angle
*/
typedef struct
{
@@ -124,7 +126,7 @@ typedef struct
} PHY_ANT_ANGLE;
/**
* @enum PhysicalLayerTimeWordType
* @enum PHY_TIME_WORD_TYPE
*/
typedef enum
{
@@ -134,7 +136,7 @@ typedef enum
} PHY_TIME_WORD_TYPE;
/**
* @enum PhysicalLayerAntennaBeamWidth
* @enum PHY_ANT_BEAM_WIDTH
*/
typedef enum
{
@@ -146,7 +148,7 @@ typedef enum
} PHY_ANT_BEAM_WIDTH;
/**
* @enum PhysicalLayerTorState
* @enum PHY_TOR_TYPE
*/
typedef enum
{
@@ -156,7 +158,7 @@ typedef enum
} PHY_TOR_TYPE;
/**
* @enum PhysicalLayerWorkMode
* @enum PHY_MODE
*/
typedef enum
{
@@ -167,7 +169,7 @@ typedef enum
} PHY_MODE;
/**
* @enum PhysicalLayerAntennaMode
* @enum PHY_ANT_MODE
*/
typedef enum
{
@@ -178,7 +180,8 @@ typedef enum
} PHY_ANT_MODE;
/**
* @struct PhysicalLayerRecord
* @struct PHY_RCD
* @brief Physical Layer recode buffer
*/
typedef struct
{
@@ -188,7 +191,7 @@ typedef struct
} PHY_RCD;
/**
* @struct PhysicalLayerConfig
* @struct PHY_CONFIG
* @brief struct holds all physical layer initialization parameters
*/
typedef struct
@@ -209,7 +212,7 @@ typedef struct
} PHY_CONFIG;
/**
* @struct PhysicalLayerInst
* @struct PHY_INST
* @brief Physical Layer operating instance
*/
typedef struct