From 928c593bca471a623d6cb0fe49635716413e6c40 Mon Sep 17 00:00:00 2001 From: Benjamin Valentin Date: Tue, 28 Sep 2021 15:12:14 +0200 Subject: [PATCH] rtt_rtc: clarify documentation about epoch `epoch` in this context refers to `RIOT_EPOCH`, not Unix Epoch. Clarify the documentation to avoid confusion. --- drivers/include/rtt_rtc.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/drivers/include/rtt_rtc.h b/drivers/include/rtt_rtc.h index d68c72a8af..d172fb7fee 100644 --- a/drivers/include/rtt_rtc.h +++ b/drivers/include/rtt_rtc.h @@ -28,7 +28,8 @@ extern "C" { #endif /** - * @brief Set the time as epoch with sub-second precision + * @brief Set the time as epoch (elapsed seconds since @ref RIOT_EPOCH) + * with sub-second precision * This feature is an extension provided by the `rtt_rtc` module. * * @note The actual µs precision depends on the underlying hardware. @@ -40,7 +41,8 @@ extern "C" { void rtt_rtc_settimeofday(uint32_t s, uint32_t us); /** - * @brief Get the current epoch with sub-second precision + * @brief Get the current epoch (elapsed seconds since @ref RIOT_EPOCH) + * with sub-second precision * This feature is an extension provided by the `rtt_rtc` module. * * @note The actual µs precision depends on the underlying hardware.