Diff: KL25Z_RTC.h

Revision:

3:2cee0b9ac1ff

Parent:

2:56a50064749e

Child:

4:3bd0dc0c2b2e

--- a/KL25Z_RTC.h	Wed Jun 19 09:03:44 2013 +0000
+++ b/KL25Z_RTC.h	Fri Jun 21 02:22:00 2013 +0000
@@ -60,13 +60,41 @@
 class KL25Z_RTC
 {
 public:
+    /** Constructor.
+     * 
+     * @param   alarm espressed in seconds
+     */
     KL25Z_RTC( unsigned int alarm);
+    
+    /** Start the RTC module
+     * @param none
+     * @return none
+     */
     void RTC_Start( void);
+    
+    /** Start the module. Setting up the IRQ handler for the second IRQ and/or for the Alarm
+     * @param   sec_ptr, alrm_ptr pointer to the IRQ handler
+     * @return none
+     */
     void RTC_Start( void(*sec_ptr)(void), void(*alrm_ptr)(void));
+    
+    /** Return the alarm value
+     * @param   none
+     * #return  the alarm value
+     */
     unsigned int RTC_GetAlarm( void);
+    
+    /** Configure the alarm value
+     * @param   alarm in seconds
+     * @return  none
+     */
     void RTC_SetAlarm( unsigned int alarm);
+    
+    /** Return the second elapsed
+     * @param   none
+     * @return  the second elapsed
+     */
     unsigned int RTC_Read( void);
-    void RTC_Seconds_CallBack( void(*fptr)(void));
     
 private: