From 62346e9b69ff13cb7d48568fbad4fbed7e781327 Mon Sep 17 00:00:00 2001 From: Marti Bolivar Date: Sat, 11 Jun 2011 23:49:18 -0400 Subject: adc.h: Clarify adc_smp_rate Doxygen comment. Thanks to gbulmer for the clarifying remarks. --- libmaple/adc.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'libmaple/adc.h') diff --git a/libmaple/adc.h b/libmaple/adc.h index 109f21f..d0b85fa 100644 --- a/libmaple/adc.h +++ b/libmaple/adc.h @@ -288,7 +288,11 @@ typedef enum adc_extsel_event { void adc_set_extsel(const adc_dev *dev, adc_extsel_event event); void adc_foreach(void (*fn)(const adc_dev*)); -/** ADC per-sample conversion times, in ADC clock cycles */ +/** + * @brief ADC sample times, in ADC clock cycles + * + * These control the amount of time spent sampling the input voltage. + */ typedef enum { ADC_SMPR_1_5, /**< 1.5 ADC cycles */ ADC_SMPR_7_5, /**< 7.5 ADC cycles */ -- cgit v1.2.3