stmhal: Add example use to RTC doc; add rtc.c to gendoc.py.

dpgeorge · dpgeorge · commit ffaf8be1c6c1 · 2014-05-03T12:02:21.000Z
diff --git a/stmhal/gendoc.py b/stmhal/gendoc.py
@@ -343,7 +343,7 @@ def main():
     args = cmd_parser.parse_args()
 
     if len(args.files) == 0:
-        args.files = ['modpyb.c', 'accel.c', 'adc.c', 'dac.c', 'extint.c', 'i2c.c', 'led.c', 'pin.c', 'rng.c', 'servo.c', 'spi.c', 'uart.c', 'usrsw.c', 'timer.c']
+        args.files = ['modpyb.c', 'accel.c', 'adc.c', 'dac.c', 'extint.c', 'i2c.c', 'led.c', 'pin.c', 'rng.c', 'servo.c', 'spi.c', 'uart.c', 'usrsw.c', 'timer.c', 'rtc.c']
 
     doc = Doc()
     for file in args.files:
diff --git 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;
 
