From ffaf8be1c6c1435240e80b2ec3a61a8548db1f26 Mon Sep 17 00:00:00 2001
From: Damien George
Date: Sat, 3 May 2014 12:02:21 +0000
Subject: stmhal: Add example use to RTC doc; add rtc.c to gendoc.py.

---
 stmhal/rtc.c | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'stmhal/rtc.c')

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;
 
-- 
cgit v1.2.3