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-22 04:08:22 +0300
committerKarl Palsson <karlp@tweak.net.au>2019-06-22 04:38:20 +0300
commit0626f6f75d748acd4a689589cabf5d2151864714 (patch)
treea81078a22a8d6e831130c0de1d2d7dd7cf5824db
parentae777bb9200dbcc205d4032b4bba6f906ff1860a (diff)
doc: efm32: adc: enable peripheral_apis style
-rw-r--r--include/libopencm3/efm32/common/adc_common.h12
-rw-r--r--include/libopencm3/efm32/ezr32wg/adc.h14
-rw-r--r--include/libopencm3/efm32/lg/adc.h13
-rw-r--r--include/libopencm3/efm32/wg/adc.h14
-rw-r--r--lib/efm32/common/adc_common.c7
5 files changed, 43 insertions, 17 deletions
diff --git a/include/libopencm3/efm32/common/adc_common.h b/include/libopencm3/efm32/common/adc_common.h
index cc41c197..0ce80a41 100644
--- a/include/libopencm3/efm32/common/adc_common.h
+++ b/include/libopencm3/efm32/common/adc_common.h
@@ -1,3 +1,5 @@
+/** @addtogroup adc_defines
+ */
/*
* This file is part of the libopencm3 project.
*
@@ -17,8 +19,9 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef LIBOPENCM3_EFM32_ADC_H
-#define LIBOPENCM3_EFM32_ADC_H
+/**@{*/
+
+#pragma once
#include <libopencm3/efm32/memorymap.h>
#include <libopencm3/cm3/common.h>
@@ -340,8 +343,6 @@
#define ADC0_BIASPROG ADC_BIASPROG(ADC0)
/** @defgroup adc_ch ADC Channel Number
-@ingroup adc_defines
-
@{*/
#define ADC_CH0 0
#define ADC_CH1 1
@@ -453,5 +454,4 @@ void adc_set_calibration_single_offset(uint32_t adc, uint8_t single_offset);
END_DECLS
-#endif
-
+/**@}*/ \ No newline at end of file
diff --git a/include/libopencm3/efm32/ezr32wg/adc.h b/include/libopencm3/efm32/ezr32wg/adc.h
index f06b9492..16269311 100644
--- a/include/libopencm3/efm32/ezr32wg/adc.h
+++ b/include/libopencm3/efm32/ezr32wg/adc.h
@@ -1,3 +1,12 @@
+/** @defgroup adc_defines ADC Defines
+ *
+ * @brief <b>Defined Constants and Types for the EZR32WG Analog to Digital
+ * Converter</b>
+ *
+ * @ingroup EZR32WG_defines
+ *
+ * LGPL License Terms @ref lgpl_license
+ */
/*
* This file is part of the libopencm3 project.
*
@@ -17,9 +26,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef LIBOPENCM3_EFM32_EZR32WG_ADC_H
-#define LIBOPENCM3_EFM32_EZR32WG_ADC_H
+#pragma once
#include <libopencm3/efm32/common/adc_common.h>
-
-#endif
diff --git a/include/libopencm3/efm32/lg/adc.h b/include/libopencm3/efm32/lg/adc.h
index 5432ce64..3e8d4f5e 100644
--- a/include/libopencm3/efm32/lg/adc.h
+++ b/include/libopencm3/efm32/lg/adc.h
@@ -1,3 +1,12 @@
+/** @defgroup adc_defines ADC Defines
+ *
+ * @brief <b>Defined Constants and Types for the EFM32LG Analog to Digital
+ * Converter</b>
+ *
+ * @ingroup EFM32LG_defines
+ *
+ * LGPL License Terms @ref lgpl_license
+ */
/*
* This file is part of the libopencm3 project.
*
@@ -17,9 +26,7 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef LIBOPENCM3_EFM32_LG_ADC_H
-#define LIBOPENCM3_EFM32_LG_ADC_H
+#pragma once
#include <libopencm3/efm32/common/adc_common.h>
-#endif
diff --git a/include/libopencm3/efm32/wg/adc.h b/include/libopencm3/efm32/wg/adc.h
index 3d6e07f3..bdfadc37 100644
--- a/include/libopencm3/efm32/wg/adc.h
+++ b/include/libopencm3/efm32/wg/adc.h
@@ -1,3 +1,12 @@
+/** @defgroup adc_defines ADC Defines
+ *
+ * @brief <b>Defined Constants and Types for the EFM32WG Analog to Digital
+ * Converter</b>
+ *
+ * @ingroup EFM32WG_defines
+ *
+ * LGPL License Terms @ref lgpl_license
+ */
/*
* This file is part of the libopencm3 project.
*
@@ -17,9 +26,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef LIBOPENCM3_EFM32_WG_ADC_H
-#define LIBOPENCM3_EFM32_WG_ADC_H
+#pragma once
#include <libopencm3/efm32/common/adc_common.h>
-
-#endif
diff --git a/lib/efm32/common/adc_common.c b/lib/efm32/common/adc_common.c
index f1d14aeb..4c7a1481 100644
--- a/lib/efm32/common/adc_common.c
+++ b/lib/efm32/common/adc_common.c
@@ -1,3 +1,6 @@
+/** @addtogroup adc_file ADC peripheral API
+ * @ingroup peripheral_apis
+ */
/*
* This file is part of the libopencm3 project.
*
@@ -19,6 +22,8 @@
#include <libopencm3/efm32/adc.h>
+/**@{*/
+
/**
* Set ADC over sampling
* @param[in] adc ADC (use ADCx)
@@ -669,3 +674,5 @@ void adc_set_calibration_single_offset(uint32_t adc, uint8_t single_offset)
{
ADC_CAL(adc) = (ADC_CAL(adc) & ADC_CAL_SINGLEOFF_MASK) | single_offset;
}
+
+/**@}*/ \ No newline at end of file