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

Merge pull request #2205 from LudwigOrtmann/periph-rtc-doc

Browse Source 
periph/rtc: move struct tm note to the top
This commit is contained in:
Ludwig Ortmann 2014-12-17 10:44:48 +01:00
commit 2ec5f9daf6
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
drivers/include/periph/rtc.h
View File

@ -11,6 +11,11 @@
* @ingroup driver_periph * @ingroup driver_periph
* @brief Low-level RTC (Real Time Clock) peripheral driver * @brief Low-level RTC (Real Time Clock) peripheral driver
* *
* @note
* The values used for setting and getting the time/alarm should
* conform to the `struct tm` specification.
* Compare: http://pubs.opengroup.org/onlinepubs/7908799/xsh/time.h.html
*
* @{ * @{
* @file * @file
* @brief Low-level RTC peripheral driver interface definitions * @brief Low-level RTC peripheral driver interface definitions
@ -68,9 +73,6 @@ int rtc_get_time(struct tm *time);
* *
* @note Any already set alarm will be overwritten. * @note Any already set alarm will be overwritten.
* *
* The values in `tm` are expected to conform to the `struct tm` specification.
* Compare: http://pubs.opengroup.org/onlinepubs/7908799/xsh/time.h.html
*
* @param[in] time The value to trigger an alarm when hit. * @param[in] time The value to trigger an alarm when hit.
* @param[in] cb Callback executed when alarm is hit. * @param[in] cb Callback executed when alarm is hit.
* @param[in] arg Argument passed to callback when alarm is hit. * @param[in] arg Argument passed to callback when alarm is hit.