summaryrefslogtreecommitdiff
path: root/stmhal/rtc.c
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-05-03 12:02:21 +0000
committerDamien George <damien.p.george@gmail.com>2014-05-03 12:02:21 +0000
commitffaf8be1c6c1435240e80b2ec3a61a8548db1f26 (patch)
treec8e52ab95472e71ffabb52ab45564c371eb0e45d /stmhal/rtc.c
parent3119b600d8578d866de76d49287099e3cc5685ed (diff)
stmhal: Add example use to RTC doc; add rtc.c to gendoc.py.
Diffstat (limited to 'stmhal/rtc.c')
-rw-r--r--stmhal/rtc.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/stmhal/rtc.c b/stmhal/rtc.c
index 28c139db0..ec3c0126b 100644
--- a/stmhal/rtc.c
+++ b/stmhal/rtc.c
@@ -14,6 +14,12 @@
///
/// The RTC is and independent clock that keeps track of the date
/// and time.
+///
+/// Example usage:
+///
+/// rtc = pyb.RTC()
+/// rtc.datetime((2014, 5, 1, 4, 13, 0, 0, 0))
+/// print(rtc.datetime())
RTC_HandleTypeDef RTCHandle;