aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 23:49:18 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 23:49:18 -0400
commit62346e9b69ff13cb7d48568fbad4fbed7e781327 (patch)
treed5a44a3e605b0e14d4fc1e713a800af26c4fe5e1
parent12164febf74004df113c7e1cee30558dcf2b0dcf (diff)
downloadlibrambutan-62346e9b69ff13cb7d48568fbad4fbed7e781327.tar.gz
librambutan-62346e9b69ff13cb7d48568fbad4fbed7e781327.zip
adc.h: Clarify adc_smp_rate Doxygen comment.
Thanks to gbulmer for the clarifying remarks.
-rw-r--r--libmaple/adc.h6
1 files changed, 5 insertions, 1 deletions
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 */