From a96c4114c3fe12bf01d5aa85bbf056c92001b4bf Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Sat, 8 Feb 2020 08:57:07 +0000 Subject: [PATCH] Small documentation fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@13326 27425a3e-05d8-49a3-a47f-9c15f0e5edd8 --- os/hal/ports/STM32/LLD/DMAv1/stm32_dma.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/os/hal/ports/STM32/LLD/DMAv1/stm32_dma.h b/os/hal/ports/STM32/LLD/DMAv1/stm32_dma.h index 73b6f024b..2b6612f55 100644 --- a/os/hal/ports/STM32/LLD/DMAv1/stm32_dma.h +++ b/os/hal/ports/STM32/LLD/DMAv1/stm32_dma.h @@ -349,7 +349,7 @@ typedef struct { /** * @brief Associates a peripheral data register to a DMA stream. * @note This function can be invoked in both ISR or thread context. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -364,7 +364,7 @@ typedef struct { /** * @brief Associates a memory destination to a DMA stream. * @note This function can be invoked in both ISR or thread context. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -379,7 +379,7 @@ typedef struct { /** * @brief Sets the number of transfers to be performed. * @note This function can be invoked in both ISR or thread context. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -394,7 +394,7 @@ typedef struct { /** * @brief Returns the number of transfers to be performed. * @note This function can be invoked in both ISR or thread context. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -407,7 +407,7 @@ typedef struct { /** * @brief Programs the stream mode settings. * @note This function can be invoked in both ISR or thread context. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -432,7 +432,7 @@ typedef struct { /** * @brief DMA stream enable. * @note This function can be invoked in both ISR or thread context. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -450,7 +450,7 @@ typedef struct { * @note This function can be invoked in both ISR or thread context. * @note Interrupts enabling flags are set to zero after this call, see * bug 3607518. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -466,7 +466,7 @@ typedef struct { /** * @brief DMA stream interrupt sources clear. * @note This function can be invoked in both ISR or thread context. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -481,7 +481,7 @@ typedef struct { * @brief Starts a memory to memory operation using the specified stream. * @note The default transfer data mode is "byte to byte" but it can be * changed by specifying extra options in the @p mode parameter. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure @@ -507,7 +507,7 @@ typedef struct { /** * @brief Polled wait for DMA transfer end. - * @pre The stream must have been allocated using @p dmaStreamAllocate(). + * @pre The stream must have been allocated using @p dmaStreamAlloc(). * @post After use the stream can be released using @p dmaStreamRelease(). * * @param[in] dmastp pointer to a stm32_dma_stream_t structure