mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

Diff: rtc_api.h

Revision:
122:f9eeca106725
Parent:
65:5798e58a58b1
--- a/rtc_api.h	Wed May 25 16:44:06 2016 +0100
+++ b/rtc_api.h	Thu Jul 07 14:34:11 2016 +0100
@@ -26,13 +26,43 @@
 extern "C" {
 #endif
 
+/**
+ * \defgroup hal_rtc RTC hal functions
+ * @{
+ */
+
+/** Initialize the RTC peripheral
+ *
+ */
 void rtc_init(void);
+
+/** Deinitialize RTC
+ *
+ * TODO: The function is not used by rtc api in mbed-drivers.
+ */
 void rtc_free(void);
+
+/** Get the RTC enable status
+ *
+ * @retval 0 disabled
+ * @retval 1 enabled
+ */
 int rtc_isenabled(void);
 
+/** Get the current time from the RTC peripheral
+ *
+ * @return The current time
+ */
 time_t rtc_read(void);
+
+/** Set the current time to the RTC peripheral
+ *
+ * @param t The current time to be set
+ */
 void rtc_write(time_t t);
 
+/**@}*/
+
 #ifdef __cplusplus
 }
 #endif