aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/src/adc.c
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/src/adc.c')
-rw-r--r--os/hal/src/adc.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/os/hal/src/adc.c b/os/hal/src/adc.c
index 4eafafac4..23b096f3e 100644
--- a/os/hal/src/adc.c
+++ b/os/hal/src/adc.c
@@ -209,6 +209,9 @@ bool_t adcStartConversionI(ADCDriver *adcp,
/**
* @brief Stops an ongoing conversion.
+ * @details This function stops the currently ongoing conversion and returns
+ * the driver in the @p ADC_READY state. If there was no conversion
+ * being processed then the function does nothing.
*
* @param[in] adcp pointer to the @p ADCDriver object
*/
@@ -236,6 +239,9 @@ void adcStopConversion(ADCDriver *adcp) {
/**
* @brief Stops an ongoing conversion.
+ * @details This function stops the currently ongoing conversion and returns
+ * the driver in the @p ADC_READY state. If there was no conversion
+ * being processed then the function does nothing.
*
* @param[in] adcp pointer to the @p ADCDriver object
*/