doc: efm32: fix doxygen warnings

Mind you, this doesn't actually fix that most of these are _missing_
that is a subsequent commit
This commit is contained in:
Karl Palsson 2019-06-17 21:53:27 +00:00
parent b9c437331f
commit a5562f27c0
4 changed files with 18 additions and 15 deletions

View File

@ -633,6 +633,7 @@ uint32_t adc_scan_data_peak(uint32_t adc)
/** /**
* Set ADC scan gain calibration * Set ADC scan gain calibration
* @param[in] adc ADC (use ADCx) * @param[in] adc ADC (use ADCx)
* @param scan_gain calibration of gain for internal ref
*/ */
void adc_set_calibration_scan_gain(uint32_t adc, uint8_t scan_gain) void adc_set_calibration_scan_gain(uint32_t adc, uint8_t scan_gain)
{ {
@ -642,6 +643,7 @@ void adc_set_calibration_scan_gain(uint32_t adc, uint8_t scan_gain)
/** /**
* Set ADC scan offset calibration * Set ADC scan offset calibration
* @param[in] adc ADC (use ADCx) * @param[in] adc ADC (use ADCx)
* @param scan_offset calibration of offset for internal ref
*/ */
void adc_set_calibration_scan_offset(uint32_t adc, uint8_t scan_offset) void adc_set_calibration_scan_offset(uint32_t adc, uint8_t scan_offset)
{ {
@ -651,6 +653,7 @@ void adc_set_calibration_scan_offset(uint32_t adc, uint8_t scan_offset)
/** /**
* Set ADC single gain calibration * Set ADC single gain calibration
* @param[in] adc ADC (use ADCx) * @param[in] adc ADC (use ADCx)
* @param single_gain calibration of gain for internal ref
*/ */
void adc_set_calibration_single_gain(uint32_t adc, uint8_t single_gain) void adc_set_calibration_single_gain(uint32_t adc, uint8_t single_gain)
{ {
@ -660,6 +663,7 @@ void adc_set_calibration_single_gain(uint32_t adc, uint8_t single_gain)
/** /**
* Set ADC single offset calibration * Set ADC single offset calibration
* @param[in] adc ADC (use ADCx) * @param[in] adc ADC (use ADCx)
* @param single_offset calibration of offset for internal ref
*/ */
void adc_set_calibration_single_offset(uint32_t adc, uint8_t single_offset) void adc_set_calibration_single_offset(uint32_t adc, uint8_t single_offset)
{ {

View File

@ -54,7 +54,7 @@ bool cmu_get_lock_flag(void)
* *
* Enable the clock on particular peripheral. * Enable the clock on particular peripheral.
* *
* @param[in] periph enum cmu_periph_clken Peripheral Name * @param[in] clken Peripheral Name
* *
* For available constants, see @a enum::cmu_periph_clken (CMU_LEUART1 for * For available constants, see @a enum::cmu_periph_clken (CMU_LEUART1 for
* example) * example)
@ -69,7 +69,7 @@ void cmu_periph_clock_enable(enum cmu_periph_clken clken)
* @brief Disable Peripheral Clock in running mode. * @brief Disable Peripheral Clock in running mode.
* Disable the clock on particular peripheral. * Disable the clock on particular peripheral.
* *
* @param[in] periph enum cmu_periph_clken Peripheral Name * @param[in] clken Peripheral Name
* *
* For available constants, see @a enum::cmu_periph_clken (CMU_LEUART1 for * For available constants, see @a enum::cmu_periph_clken (CMU_LEUART1 for
* example) * example)

View File

@ -95,8 +95,8 @@ void dac_disable_sine(uint32_t dac)
/** /**
* Set PRS trigger source on DAC channel * Set PRS trigger source on DAC channel
* @param[in] dac DAC (use DACx) * @param[in] dac DAC (use DACx)
* @param[in] dac_ch DAC Channel (use DAC_CHx) * @param[in] dac_chan DAC Channel (use DAC_CHx)
* @param[in] prs_ch PRS Channel (use PRS_CHx) * @param[in] prs_chan PRS Channel (use PRS_CHx)
*/ */
void dac_set_prs_trigger(uint32_t dac, enum dac_ch dac_chan, void dac_set_prs_trigger(uint32_t dac, enum dac_ch dac_chan,
enum prs_ch prs_chan) enum prs_ch prs_chan)
@ -110,7 +110,7 @@ void dac_set_prs_trigger(uint32_t dac, enum dac_ch dac_chan,
/** /**
* Enable PRS triggerring * Enable PRS triggerring
* @param[in] dac DAC (use DACx) * @param[in] dac DAC (use DACx)
* @param[in] dac_ch DAC Channel (use DAC_CHx) * @param[in] ch DAC Channel (use DAC_CHx)
*/ */
void dac_enable_prs_trigger(uint32_t dac, enum dac_ch ch) void dac_enable_prs_trigger(uint32_t dac, enum dac_ch ch)
{ {
@ -120,7 +120,7 @@ void dac_enable_prs_trigger(uint32_t dac, enum dac_ch ch)
/** /**
* Disable PRS triggerring * Disable PRS triggerring
* @param[in] dac DAC (use DACx) * @param[in] dac DAC (use DACx)
* @param[in] dac_ch DAC Channel (use DAC_CHx) * @param[in] ch DAC Channel (use DAC_CHx)
*/ */
void dac_disable_prs_trigger(uint32_t dac, enum dac_ch ch) void dac_disable_prs_trigger(uint32_t dac, enum dac_ch ch)
{ {
@ -130,7 +130,7 @@ void dac_disable_prs_trigger(uint32_t dac, enum dac_ch ch)
/** /**
* Enable auto refresh * Enable auto refresh
* @param[in] dac DAC (use DACx) * @param[in] dac DAC (use DACx)
* @param[in] dac_ch DAC Channel (use DAC_CHx) * @param[in] ch DAC Channel (use DAC_CHx)
*/ */
void dac_enable_auto_refresh(uint32_t dac, enum dac_ch ch) void dac_enable_auto_refresh(uint32_t dac, enum dac_ch ch)
{ {
@ -140,7 +140,7 @@ void dac_enable_auto_refresh(uint32_t dac, enum dac_ch ch)
/** /**
* Disable auto refresh * Disable auto refresh
* @param[in] dac DAC (use DACx) * @param[in] dac DAC (use DACx)
* @param[in] dac_ch DAC Channel (use DAC_CHx) * @param[in] ch DAC Channel (use DAC_CHx)
*/ */
void dac_disable_auto_refresh(uint32_t dac, enum dac_ch ch) void dac_disable_auto_refresh(uint32_t dac, enum dac_ch ch)
{ {
@ -150,7 +150,7 @@ void dac_disable_auto_refresh(uint32_t dac, enum dac_ch ch)
/** /**
* Enable channel * Enable channel
* @param[in] dac DAC (use DACx) * @param[in] dac DAC (use DACx)
* @param[in] dac_ch DAC Channel (use DAC_CHx) * @param[in] ch DAC Channel (use DAC_CHx)
*/ */
void dac_enable_channel(uint32_t dac, enum dac_ch ch) void dac_enable_channel(uint32_t dac, enum dac_ch ch)
{ {
@ -160,7 +160,7 @@ void dac_enable_channel(uint32_t dac, enum dac_ch ch)
/** /**
* Disable channel * Disable channel
* @param[in] dac DAC (use DACx) * @param[in] dac DAC (use DACx)
* @param[in] dac_ch DAC Channel (use DAC_CHx) * @param[in] ch DAC Channel (use DAC_CHx)
*/ */
void dac_disable_channel(uint32_t dac, enum dac_ch ch) void dac_disable_channel(uint32_t dac, enum dac_ch ch)
{ {

View File

@ -563,8 +563,8 @@ static inline uint32_t dma_calc_end_from_start(uint32_t start, uint8_t inc,
* descriptor * descriptor
* @param[in] ch Channel (use DMA_CHx) * @param[in] ch Channel (use DMA_CHx)
* @param[in] src_start Source data start address * @param[in] src_start Source data start address
* @param[in] this function use dma_desc_set_count() and dma_desc_set_src_inc() * this function uses @ref dma_calc_end_from_start to calculate the
* set value to calculate the src data end address from @a src_start * src data end address from @a src_start
* @note dma_desc_set_count() should be called first. * @note dma_desc_set_count() should be called first.
* @note dma_desc_set_src_inc() should be called first. * @note dma_desc_set_src_inc() should be called first.
*/ */
@ -586,9 +586,8 @@ void dma_desc_set_src_address(uint32_t desc_base, enum dma_ch ch,
* descriptor * descriptor
* @param[in] ch Channel (use DMA_CHx) * @param[in] ch Channel (use DMA_CHx)
* @param[in] dest_start Destination data start address * @param[in] dest_start Destination data start address
* @param[in] this function use dma_desc_set_count() and * this function uses @ref dma_calc_end_from_start to calculate the
* dma_desc_set_dest_inc() set value to calculate the dest data end * dest data end address from @a dest_start
* address from @a dest_start
* @note dma_desc_set_count() should be called first. * @note dma_desc_set_count() should be called first.
* @note dma_desc_set_dest_inc() should be called first. * @note dma_desc_set_dest_inc() should be called first.
*/ */