Better struct comment

2024-03-28 15:58:15 +08:00
parent 16d1ad30a7
commit 8d72288675
15 changed files with 154 additions and 131 deletions
@@ -69,16 +69,28 @@
 	IO_In32((baseAddr) + (offset))

 /************************** Data Type Definitions ****************************/
+/**
+ * @struct SYSBUS_UART_CONFIG
+ * @brief SystemBus UART driver initialization parameters
+ */
 typedef struct
 {
 	uintptr_t baseAddr;
 } SYSBUS_UART_CONFIG;

+/**
+ * @struct  SYSBUS_UART
+ * @brief SystemBus UART driver instance
+ */
 typedef struct
 {
 	SYSBUS_UART_CONFIG config;
 } SYSBUS_UART;

+/**
+ * @struct  SYSBUS_UART_FRAME
+ * @brief SystemBus UART frame definition
+ */
 typedef struct
 {
 	uint16_t len;