adc.h: Clarify adc_smp_rate Doxygen comment.

Thanks to gbulmer for the clarifying remarks.
leaflabs · Jun 12, 2011 · 76b9fd0 · 76b9fd0
1 parent 3d18dec
commit 76b9fd0
Showing 1 changed file with 5 additions and 1 deletion.
diff --git 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 */