Diff: ds3231.cpp

Revision:

3:312589d8185c

Parent:

2:4e6e761c60f2

Child:

4:0beb5e9ac927

--- a/ds3231.cpp	Thu Nov 20 00:03:27 2014 +0000
+++ b/ds3231.cpp	Thu Nov 20 21:06:57 2014 +0000
@@ -81,7 +81,6 @@
 *
 * On Entry:
 *     @param[in] time - struct cotaining time data; 
-*                       seconds, minutes and hours
 *
 * On Exit:
 *     @return return value = 0 on success, non-0 on failure
@@ -144,8 +143,7 @@
 * Sets the calendar on DS3231
 *
 * On Entry:
-*     @param[in] calendar - struct cotaining calendar data; 
-*                           day, date, month, year
+*     @param[in] calendar - struct cotaining calendar data 
 *
 * On Exit:
 *     @return return value = 0 on success, non-0 on failure
@@ -185,8 +183,7 @@
 *
 * On Entry:
 *     @param[in] alarm - struct cotaining alarm data 
-*                        seconds, minutes, hours, day, date
-*                        seconds used on Alarm1 only
+*                        
 *     @param[in] one_r_two - TRUE for Alarm1 and FALSE for 
 *                            Alarm2
 *
@@ -392,7 +389,7 @@
 * ds3231_time_t time = {0, 0, 0} // time = 0:0:0 24hr format
 * uint16_t rtn_val;
 *
-* rtn_val = rtc.get_time(time);
+* rtn_val = rtc.get_time(&time);
 *
 * @endcode
 **************************************************************/
@@ -440,7 +437,7 @@
 * ds3231_calendar_t calendar = {1, 1, 1, 0}; 
 * uint16_t rtn_val;
 *
-* rtn_val = rtc.get_calendar(calendar);
+* rtn_val = rtc.get_calendar(&calendar);
 *
 * @endcode
 **************************************************************/
@@ -492,7 +489,7 @@
 * ds3231_alrm_t alarm = {0, 0, 0, 0, 0}; 
 * uint16_t rtn_val;
 *
-* rtn_val = rtc.get_alarm(alarm, FALSE);
+* rtn_val = rtc.get_alarm(&alarm, FALSE);
 *
 * @endcode
 **************************************************************/
@@ -572,7 +569,7 @@
 * //do not use 0xAA, see datasheet for appropriate data 
 * ds3231_cntl_stat_t data = {0xAA, 0xAA}; 
 *
-* rtn_val = rtc.get_cntl_stat_reg(data);
+* rtn_val = rtc.get_cntl_stat_reg(&data);
 *
 * @endcode
 **************************************************************/