doc: efm32: adc: enable peripheral_apis style

This commit is contained in:
Karl Palsson 2019-06-22 01:08:22 +00:00
parent ae777bb920
commit 0626f6f75d
5 changed files with 43 additions and 17 deletions

View File

@ -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
/**@}*/

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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;
}
/**@}*/