RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

rtt_rtc: clarify documentation about epoch

Browse Source 
`epoch` in this context refers to `RIOT_EPOCH`, not Unix Epoch.
Clarify the documentation to avoid confusion.
This commit is contained in:
Benjamin Valentin 2021-09-28 15:12:14 +02:00
parent 73e32207df
commit 928c593bca
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
drivers/include/rtt_rtc.h
View File

@ -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.