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
@@ -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