commit 7b93bdcad5c75a12c3366fd5b3ee5e85285ddec0
author Ali Labbene <ali.labbene@st.com> Wed Nov 02 14:12:29 2022 +0100
committer Ali Labbene <ali.labbene@st.com> Wed Nov 02 14:12:29 2022 +0100
tree ce2a0f605092389e9be68ccd137bee03297a9258
parent 115f163e2c37f0087b97af9e0f7a5f03078eceae

[HAL][USART] Improve header description of USART_WaitOnFlagUntilTimeout() function

Src/stm32f3xx_hal_usart.c

diff --git a/Src/stm32f3xx_hal_usart.c b/Src/stm32f3xx_hal_usart.c
index 65b74dc..fba891c 100644
--- a/Src/stm32f3xx_hal_usart.c
+++ b/Src/stm32f3xx_hal_usart.c
@@ -2662,10 +2662,11 @@
 
 
 /**
-  * @brief  Handle USART Communication Timeout.
+  * @brief  Handle USART Communication Timeout. It waits
+  *         until a flag is no longer in the specified status.
   * @param  husart USART handle.
   * @param  Flag Specifies the USART flag to check.
-  * @param  Status the Flag status (SET or RESET).
+  * @param  Status the actual Flag status (SET or RESET).
   * @param  Tickstart Tick start value
   * @param  Timeout timeout duration.
   * @retval HAL status