diff options
Diffstat (limited to 'os/hal/src')
| -rw-r--r-- | os/hal/src/adc.c | 12 | ||||
| -rw-r--r-- | os/hal/src/pwm.c | 2 |
2 files changed, 8 insertions, 6 deletions
diff --git a/os/hal/src/adc.c b/os/hal/src/adc.c index 2a329d003..5348d7e93 100644 --- a/os/hal/src/adc.c +++ b/os/hal/src/adc.c @@ -112,11 +112,10 @@ void adcStop(ADCDriver *adcp) { * @brief Starts an ADC conversion.
* @details Starts a conversion operation, there are two kind of conversion
* modes:
- * - <b>LINEAR</b>, this mode is activated when the @p callback
- * parameter is set to @p NULL, in this mode the buffer is filled
- * once and then the conversion stops automatically.
- * - <b>CIRCULAR</b>, when a callback function is defined the
- * conversion never stops and the buffer is filled circularly.
+ * - <b>LINEAR</b>, in this mode the buffer is filled once and then
+ * the conversion stops automatically.
+ * - <b>CIRCULAR</b>, in this mode the conversion never stops and
+ * the buffer is filled circularly.<br>
* During the conversion the callback function is invoked when
* the buffer is 50% filled and when the buffer is 100% filled,
* this way is possible to process the conversion stream in real
@@ -133,7 +132,8 @@ void adcStop(ADCDriver *adcp) { * @param[out] samples pointer to the samples buffer
* @param[in] depth buffer depth (matrix rows number). The buffer depth
* must be one or an even number.
- * @param[in] callback pointer to the conversion callback function
+ * @param[in] callback pointer to the conversion callback function, this
+ * parameter can be @p NULL if a callback is not required
* @return The operation status.
* @retval FALSE the conversion has been started.
* @retval TRUE the driver is busy, conversion not started.
diff --git a/os/hal/src/pwm.c b/os/hal/src/pwm.c index 3aeec1309..4b797da0c 100644 --- a/os/hal/src/pwm.c +++ b/os/hal/src/pwm.c @@ -20,6 +20,7 @@ /**
* @file pwm.c
* @brief PWM Driver code.
+ *
* @addtogroup PWM
* @{
*/
@@ -104,6 +105,7 @@ void pwmStop(PWMDriver *pwmp) { /**
* @brief Enables a PWM channel.
+ * @details Programs (or reprograms) a PWM channel.
*
* @param[in] pwmp pointer to a @p PWMDriver object
* @param[in] channel PWM channel identifier
|