From da1c13fcb0e8ec945b9c6ba92aff0fa183aae8c5 Mon Sep 17 00:00:00 2001 From: Erick Ahmed Date: Tue, 16 Jun 2026 21:02:15 +0200 Subject: [PATCH] Fix comment blocks and function descriptions --- Core/Inc/canlog.h | 5 ----- Core/Src/canlog.c | 8 ++++---- 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/Core/Inc/canlog.h b/Core/Inc/canlog.h index 6334f30..2a037ed 100644 --- a/Core/Inc/canlog.h +++ b/Core/Inc/canlog.h @@ -45,11 +45,6 @@ typedef struct { } CanMessage_t; /* USER CODE END PTD */ -/** - * @brief Initializes the CAN logger modules, OS threads, queues, and hardware. - * @param hcan1 Pointer to the CAN1 handle - * @param hcan2 Pointer to the CAN2 handle - */ void CAN_Logger_Init(CAN_HandleTypeDef *hcan1, CAN_HandleTypeDef *hcan2); void HAL_CAN_RxFifo0MsgPendingCallback(CAN_HandleTypeDef *hcan); void vCANLoggerListen(void *argument); diff --git a/Core/Src/canlog.c b/Core/Src/canlog.c index eec2457..6bc83b4 100644 --- a/Core/Src/canlog.c +++ b/Core/Src/canlog.c @@ -31,10 +31,10 @@ extern osEventFlagsId_t xCanEventFlags; /* Private function prototypes -----------------------------------------------*/ /* USER CODE BEGIN FunctionPrototypes */ -/* BEGIN CAN_Logger_Init */ /** - * @brief Initialize CAN bus logger. - * @param argument: hcan1, hcan2 + * @brief Initializes the CAN logger modules, OS threads, queues, and hardware. + * @param hcan1 Pointer to the CAN1 handle + * @param hcan2 Pointer to the CAN2 handle * @retval None */ void CAN_Logger_Init(CAN_HandleTypeDef *hcan1, CAN_HandleTypeDef *hcan2) @@ -63,7 +63,7 @@ void CAN_Logger_Init(CAN_HandleTypeDef *hcan1, CAN_HandleTypeDef *hcan2) /* BEGIN HAL_CAN_RxFifo0MsgPendingCallback */ /** * @brief ISR for CAN message pending in FIFO0 - * @param argument: Can handle hcan (hcan1 or hcan2) + * @param hcan: CAN handle hcan (hcan1 or hcan2) * @retval None */ void HAL_CAN_RxFifo0MsgPendingCallback(CAN_HandleTypeDef *hcan)