From 64707c404c8448f9c7e562839471a051a9192b1e Mon Sep 17 00:00:00 2001 From: Mark Rages Date: Mon, 15 Feb 2021 17:00:26 -0600 Subject: [PATCH] Fix documentation of I2C_WaitOnFlagUntilTimeout() to match code. --- Drivers/STM32F3xx_HAL_Driver/Src/stm32f3xx_hal_i2c.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Drivers/STM32F3xx_HAL_Driver/Src/stm32f3xx_hal_i2c.c b/Drivers/STM32F3xx_HAL_Driver/Src/stm32f3xx_hal_i2c.c index 88ab18ba..c648d664 100644 --- a/Drivers/STM32F3xx_HAL_Driver/Src/stm32f3xx_hal_i2c.c +++ b/Drivers/STM32F3xx_HAL_Driver/Src/stm32f3xx_hal_i2c.c @@ -6345,11 +6345,12 @@ static void I2C_DMAAbort(DMA_HandleTypeDef *hdma) } /** - * @brief This function handles I2C Communication Timeout. + * @brief This function handles I2C Communication Timeout. It waits + * until a flag is no longer in the specified status. * @param hi2c Pointer to a I2C_HandleTypeDef structure that contains * the configuration information for the specified I2C. * @param Flag Specifies the I2C flag to check. - * @param Status The new Flag status (SET or RESET). + * @param Status The existing Flag status (SET or RESET). * @param Timeout Timeout duration * @param Tickstart Tick start value * @retval HAL status