riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #16906 from benpicco/rtt_rtc.h-doxfix

Browse Source 
rtt_rtc: clarify documentation about epoch
This commit is contained in:
benpicco 2021-09-28 16:11:34 +02:00 committed by GitHub
commit 7bfcda979b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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 #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. * This feature is an extension provided by the `rtt_rtc` module.
* *
* @note The actual µs precision depends on the underlying hardware. * @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); 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. * This feature is an extension provided by the `rtt_rtc` module.
* *
* @note The actual µs precision depends on the underlying hardware. * @note The actual µs precision depends on the underlying hardware.