Common Update: Better Doxygen Style

df_datalink_sp/src/systembus/systembus_uart.c

@@ -1,18 +1,26 @@
 /*****************************************************************************/
 /**
- * Description: System bus uart driver implementation file.
+ * @file systembus_uart.h
+ * @author FanHao ([email protected])
+ * @brief System bus uart driver implementation file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2023-05-06 10:59
- * LastEditTime: 2023-05-06 21:56
- * Revisions: Rev 0.0
- * History:
- * [2023-05-06]: Initial version.
- *
- * Copyright(c) 2022 Beijing Institute of Technology.
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
  *
  ******************************************************************************/
+/**
+ * @addtogroup SystemBus
+ * @{
+ */
+
+/**
+ * @addtogroup SystemBus_UART
+ * @{
+ */
+
 
-/***************************** Include Files *******************************/
 #include <stdlib.h>
 #include <string.h>
 #include <stdint.h>
@@ -20,6 +28,10 @@
 #include "systembus_uart.h"
 #include "common.h"
 
+/**
+ * @name SystemBus_UART_Driver_Constants
+ * @{
+ */
 // Control and status register
 #define MODULE_VERSION 0
 #define UART_STATUS 4
@@ -47,7 +59,7 @@
 #define FRAME_CHECK_LEN 1	 // CheckSum
 #define FRAME_INFO_LEN 3	 // CheckSum, Dummy and DataLen
 #define FRAME_OVERHEAD_LEN 7 // CheckSum, Dummy and DataLen
-/*************************** Function Definitions ****************************/
+/** @} SystemBus_UART_Driver_Constants*/
 
 /*****************************************************************************/
 /**
@@ -246,3 +258,7 @@ bool SysbusUart_IsTxBusy(SYSBUS_UART *instPtr)
 		return false;
 	}
 }
+
+/** @} SystemBus_UART*/
+
+/** @} SystemBus*/