From 3df3ed7db92c39a1b71e0f65d0dc373fbcc831dc Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Fri, 6 Mar 2020 01:13:22 +0000 Subject: [PATCH] doc: stm32f0/f3: adc: fix doxygen warnings --- lib/stm32/f0/adc.c | 13 +++++-------- lib/stm32/f3/adc.c | 24 ++++++++---------------- 2 files changed, 13 insertions(+), 24 deletions(-) diff --git a/lib/stm32/f0/adc.c b/lib/stm32/f0/adc.c index c6f40092..c6165e39 100644 --- a/lib/stm32/f0/adc.c +++ b/lib/stm32/f0/adc.c @@ -78,7 +78,7 @@ void adc_disable_discontinuous_mode(uint32_t adc) * next channel in the list is prepared to convert on next trigger edge. * * @note This mode can be emulated by ADC_MODE_GROUPED with group size - * of 1. @par + * of 1. * * @li @c ADC_MODE_SCAN: T(0123)[EOSEQ] T(0123)[EOSEQ] T(0123)[EOSEQ] * @@ -86,7 +86,7 @@ void adc_disable_discontinuous_mode(uint32_t adc) * storing results sequentially. * * @note The DMA must be configured properly for more than single channel to - * convert. @par + * convert. * * @li @c ADC_MODE_SCAN_INFINITE: T(0123[EOSEQ]0123[EOSEQ]0123[EOSEQ]...) * @@ -102,19 +102,16 @@ void adc_disable_discontinuous_mode(uint32_t adc) * and on the next trigger it wraps to the beginning. * * @note The DMA must be configured properly to operate on more than single - * channel conversion groups.@par + * channel conversion groups. * * @warning not all families supports all modes of operation of ADC. * - * @par - * */ /*---------------------------------------------------------------------------*/ /** @brief ADC Set conversion operation mode * * @note on SEQUENTIAL mode, the trigger event is necessary to start conversion. - * @par * * @param[in] adc Unsigned int32. ADC base address (@ref adc_reg_base) * @param[in] opmode ADC operation mode @@ -516,7 +513,7 @@ void adc_disable_analog_watchdog(uint32_t adc) /** @brief ADC Set Analog Watchdog Upper Threshold * * @param[in] adc Unsigned int32. ADC base address (@ref adc_reg_base) - * @param[in] threshold. Upper threshold value + * @param[in] threshold Upper threshold value */ void adc_set_watchdog_high_threshold(uint32_t adc, uint16_t threshold) @@ -528,7 +525,7 @@ void adc_set_watchdog_high_threshold(uint32_t adc, uint16_t threshold) /** @brief ADC Set Analog Watchdog Lower Threshold * * @param[in] adc Unsigned int32. ADC base address (@ref adc_reg_base) - * @param[in] threshold. Lower threshold value + * @param[in] threshold Lower threshold value */ void adc_set_watchdog_low_threshold(uint32_t adc, uint16_t threshold) diff --git a/lib/stm32/f3/adc.c b/lib/stm32/f3/adc.c index 9adef94d..e41f33b2 100644 --- a/lib/stm32/f3/adc.c +++ b/lib/stm32/f3/adc.c @@ -155,11 +155,9 @@ void adc_disable_analog_watchdog_injected(uint32_t adc) * whole group has been converted, the next trigger will restart conversion of * the subgroup at the beginning of the whole group. * - * @param[in] adc Unsigned int32. ADC block register address base @ref - * adc_reg_base @param[in] length Unsigned int8. Number of channels in the - * group @ref adc_cr1_discnum + * @param[in] adc ADC block register address base @ref adc_reg_base + * @param[in] length Number of channels in the group @ref adc_cr1_discnum */ - void adc_enable_discontinuous_mode_regular(uint32_t adc, uint8_t length) { if ((length-1) > 7) { @@ -410,14 +408,11 @@ void adc_start_conversion_injected(uint32_t adc) } -/*---------------------------------------------------------------------------*/ -/** @brief ADC Set Analog Watchdog Upper Threshold - * - * @param[in] adc Unsigned int32. ADC block register address base +/** ADC Set Analog Watchdog Upper Threshold. + * @param[in] adc ADC block register address base * @ref adc_reg_base - * @param[in] threshold. Upper threshold value + * @param[in] threshold Upper threshold value */ - void adc_set_watchdog_high_threshold(uint32_t adc, uint16_t threshold) { uint32_t reg32 = 0; @@ -431,14 +426,11 @@ void adc_set_watchdog_high_threshold(uint32_t adc, uint16_t threshold) ADC_TR3(adc) = (ADC_TR3(adc) & mask) | reg32; } -/*---------------------------------------------------------------------------*/ -/** @brief ADC Set Analog Watchdog Lower Threshold - * - * @param[in] adc Unsigned int32. ADC block register address base +/** ADC Set Analog Watchdog Lower Threshold. + * @param[in] adc ADC block register address base * @ref adc_reg_base - * @param[in] threshold. Lower threshold value + * @param[in] threshold Lower threshold value */ - void adc_set_watchdog_low_threshold(uint32_t adc, uint16_t threshold) { uint32_t reg32 = 0;