Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/thirdpin/libopencm3.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Palsson <karlp@tweak.net.au>2019-06-18 00:53:27 +0300
committerKarl Palsson <karlp@tweak.net.au>2019-06-22 03:40:31 +0300
commita5562f27c04c05221b220d264e3c312f8a50843a (patch)
treee48a75f2f3be1439ad059636d11f0b2adf860d7b
parentb9c437331f3e4ea50cc5c7c1c499055fabee3eae (diff)
doc: efm32: fix doxygen warnings
Mind you, this doesn't actually fix that most of these are _missing_ that is a subsequent commit
-rw-r--r--lib/efm32/common/adc_common.c4
-rw-r--r--lib/efm32/common/cmu_common.c4
-rw-r--r--lib/efm32/common/dac_common.c16
-rw-r--r--lib/efm32/common/dma_common.c9
4 files changed, 18 insertions, 15 deletions
diff --git a/lib/efm32/common/adc_common.c b/lib/efm32/common/adc_common.c
index 980c7151..f1d14aeb 100644
--- a/lib/efm32/common/adc_common.c
+++ b/lib/efm32/common/adc_common.c
@@ -633,6 +633,7 @@ uint32_t adc_scan_data_peak(uint32_t adc)
/**
* Set ADC scan gain calibration
* @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)
{
@@ -642,6 +643,7 @@ void adc_set_calibration_scan_gain(uint32_t adc, uint8_t scan_gain)
/**
* Set ADC scan offset calibration
* @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)
{
@@ -651,6 +653,7 @@ void adc_set_calibration_scan_offset(uint32_t adc, uint8_t scan_offset)
/**
* Set ADC single gain calibration
* @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)
{
@@ -660,6 +663,7 @@ void adc_set_calibration_single_gain(uint32_t adc, uint8_t single_gain)
/**
* Set ADC single offset calibration
* @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)
{
diff --git a/lib/efm32/common/cmu_common.c b/lib/efm32/common/cmu_common.c
index 6edc42dd..c1472ed6 100644
--- a/lib/efm32/common/cmu_common.c
+++ b/lib/efm32/common/cmu_common.c
@@ -54,7 +54,7 @@ bool cmu_get_lock_flag(void)
*
* 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
* example)
@@ -69,7 +69,7 @@ void cmu_periph_clock_enable(enum cmu_periph_clken clken)
* @brief Disable Peripheral Clock in running mode.
* 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
* example)
diff --git a/lib/efm32/common/dac_common.c b/lib/efm32/common/dac_common.c
index 8a211afc..4d5c1036 100644
--- a/lib/efm32/common/dac_common.c
+++ b/lib/efm32/common/dac_common.c
@@ -95,8 +95,8 @@ void dac_disable_sine(uint32_t dac)
/**
* Set PRS trigger source on DAC channel
* @param[in] dac DAC (use DACx)
- * @param[in] dac_ch DAC Channel (use DAC_CHx)
- * @param[in] prs_ch PRS Channel (use PRS_CHx)
+ * @param[in] dac_chan DAC Channel (use DAC_CHx)
+ * @param[in] prs_chan PRS Channel (use PRS_CHx)
*/
void dac_set_prs_trigger(uint32_t dac, enum dac_ch dac_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
* @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)
{
@@ -120,7 +120,7 @@ void dac_enable_prs_trigger(uint32_t dac, enum dac_ch ch)
/**
* Disable PRS triggerring
* @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)
{
@@ -130,7 +130,7 @@ void dac_disable_prs_trigger(uint32_t dac, enum dac_ch ch)
/**
* Enable auto refresh
* @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)
{
@@ -140,7 +140,7 @@ void dac_enable_auto_refresh(uint32_t dac, enum dac_ch ch)
/**
* Disable auto refresh
* @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)
{
@@ -150,7 +150,7 @@ void dac_disable_auto_refresh(uint32_t dac, enum dac_ch ch)
/**
* Enable channel
* @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)
{
@@ -160,7 +160,7 @@ void dac_enable_channel(uint32_t dac, enum dac_ch ch)
/**
* Disable channel
* @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)
{
diff --git a/lib/efm32/common/dma_common.c b/lib/efm32/common/dma_common.c
index e6967bfe..856bf0ab 100644
--- a/lib/efm32/common/dma_common.c
+++ b/lib/efm32/common/dma_common.c
@@ -563,8 +563,8 @@ static inline uint32_t dma_calc_end_from_start(uint32_t start, uint8_t inc,
* descriptor
* @param[in] ch Channel (use DMA_CHx)
* @param[in] src_start Source data start address
- * @param[in] this function use dma_desc_set_count() and dma_desc_set_src_inc()
- * set value to calculate the src data end address from @a src_start
+ * this function uses @ref dma_calc_end_from_start to calculate the
+ * src data end address from @a src_start
* @note dma_desc_set_count() 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
* @param[in] ch Channel (use DMA_CHx)
* @param[in] dest_start Destination data start address
- * @param[in] this function use dma_desc_set_count() and
- * dma_desc_set_dest_inc() set value to calculate the dest data end
- * address from @a dest_start
+ * this function uses @ref dma_calc_end_from_start to calculate the
+ * dest data end address from @a dest_start
* @note dma_desc_set_count() should be called first.
* @note dma_desc_set_dest_inc() should be called first.
*/