From fb75b65df77ec89093a045249798dc051b97764b Mon Sep 17 00:00:00 2001 From: Ludwig Ortmann Date: Wed, 19 Nov 2014 16:55:52 +0100 Subject: [PATCH] periph/rtt: fix documentation Fix some typos, grammar and style. --- drivers/include/periph/rtt.h | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/drivers/include/periph/rtt.h b/drivers/include/periph/rtt.h index 11ce5b4ef2..2d0eb7e7ac 100644 --- a/drivers/include/periph/rtt.h +++ b/drivers/include/periph/rtt.h @@ -28,13 +28,14 @@ extern "C" { #endif -/* guard file in case no RTC device was specified */ +/* guard file in case no RTT device was specified */ #if RTT_NUMOF /** - * @brief Signature for alarm Callback + * @brief Signature for the alarm callback * - * @param[in] arg optional argument to put the callback in the right context + * @param[in] arg Optional argument which is passed to the + * callback */ typedef void(*rtt_cb_t)(void *arg); @@ -59,7 +60,7 @@ void rtt_clear_overflow_cb(void); /** * @brief Get the current RTT counter. * - * @return Current value of the RTT counter. + * @return Current value of the RTT counter */ uint32_t rtt_get_counter(void); @@ -73,18 +74,18 @@ void rtt_set_counter(uint32_t counter); /** * @brief Set an alarm for RTT to the specified value. * - * @param[in] alarm The value to trigger an alarm when hit. - * @param[in] cb Callback executed when alarm is hit. - * @param[in] arg Argument passed to callback when alarm is hit. + * @param[in] alarm The value to trigger an alarm when hit + * @param[in] cb Callback executed when alarm is hit + * @param[in] arg Argument passed to callback when alarm is hit */ void rtt_set_alarm(uint32_t alarm, rtt_cb_t cb, void *arg); /** * @brief Get the value of a set alarm. * - * If no alarm is set the return value is arbitrary. + * If no alarm is set, the return value is arbitrary. * - * @return value the alarm is set to + * @return Value the alarm is set to */ uint32_t rtt_get_alarm(void); @@ -94,12 +95,12 @@ uint32_t rtt_get_alarm(void); void rtt_clear_alarm(void); /** - * @brief Turns the RTC hardware module on + * @brief Turn the RTT hardware module on */ void rtt_poweron(void); /** - * @brief Turns the RTC hardware module off + * @brief Turn the RTT hardware module off */ void rtt_poweroff(void);