Diff: iCal.h

Revision:

1:db274b9e40cc

Parent:

0:49245357cd1b

Child:

3:fc5cdc930896

--- a/iCal.h	Sun Apr 20 13:25:50 2014 +0000
+++ b/iCal.h	Sun Apr 20 16:34:18 2014 +0000
@@ -1,6 +1,3 @@
-
-
-
 #ifndef ICAL_H
 #define ICAL_H
 #include "mbed.h"
@@ -62,7 +59,7 @@
 /// which permits a printf (for example) to call this api a few times
 /// and get the proper representation of each.
 ///
-/// @param t is a time value;
+/// @param[in] t is a time value;
 /// @returns a pointer to a static buffer containing the converted time.
 ///
 char * FormatCTime(time_t t);
@@ -75,13 +72,13 @@
 ///
 /// Most usefor during development, and perhaps no value after that.
 ///
-/// @param Event is the event of interest.
+/// @param[in] Event is the event of interest.
 ///
 void ShowEventInfo(Event_T & Event);
 
 /// Access the 2-letter abbreviation for the day of the week.
 /// 
-/// @param i is the day of the week, where 0 = sunday
+/// @param[in] i is the day of the week, where 0 = sunday
 /// @returns a pointer to the 2-letter abbreviation.
 ///
 const char * RepeatDayAbbrev(int i);
@@ -97,12 +94,11 @@
 /// Parses a string which can look like this: 20140505T200000
 /// into a time_t value.
 ///
-/// @param string is the string to parse.
-/// @param ntp is a reference to an NTPClient object, in order 
-///     to get the time-zone offset.
+/// @param[in] string is the string to parse.
+/// @param[in] tzoSec is the time-zone offset in seconds.
 /// @returns time_t value.
 ///
-time_t ParseDateStamp(char * string, NTPClient & ntp);
+time_t ParseDateStamp(char * string, int32_t tzoSec);
 
 /// Parse an iCal stream, and extract everything useful.
 ///
@@ -110,24 +106,22 @@
 /// of an iCal stream. It walked through all of the available
 /// information to extract the Event list. 
 ///
-/// @param pStart is a pointer to the start of the stream.
-/// @param gridStartTime is a time value representing the start of the time-window of interest.
-///     This permits 
-/// @param gridEndTime is a time value representing the end of the time-window of interest.
-/// @param ntp is a reference to an NTPClient object, in order
-///     to get the time-zone offset.
+/// @param[in] pStart is a pointer to the start of the stream.
+/// @param[in] gridStartTime is a time value representing the start of the time-window of interest.
+/// @param[in] gridEndTime is a time value representing the end of the time-window of interest.
+/// @param[in] tzoSec is the time-zone offset in seconds.
 ///
-void ParseICalStream(char * pStart, time_t gridStartTime, time_t gridEndTime, NTPClient & ntp);
+void ParseICalStream(char * pStart, time_t gridStartTime, time_t gridEndTime, int32_t tzoSec);
 
 /// Compute the intersection of two time ranges, and returns that intersection.
 ///
 /// This compares a pair of time ranges, each by a start and end time. If they overlap
 /// it then computes the intersection of those two ranges.
 ///
-/// @param start1 is the starting time of range 1.
-/// @param end1 is the ending time of range 1.
-/// @param start2 is the starting time of range 2.
-/// @param end2 is the ending time of range 2.
+/// @param[in,out] start1 is the starting time of range 1.
+/// @param[in,out] end1 is the ending time of range 1.
+/// @param[in] start2 is the starting time of range 2.
+/// @param[in] end2 is the ending time of range 2.
 /// @returns true if the ranges overlap, and then start1 and end1 are set to the
 ///     intersection.
 ///
@@ -135,9 +129,9 @@
 
 /// Computes the next interval for iCal events that have recurrence.
 /// 
-/// @param repeatFreq is a value representing the frequency of recurrence - 
+/// @param[in] repeatFreq is a value representing the frequency of recurrence - 
 ///     0=none, 1=daily, 2=weekly, 3=monthly, 4=yearly
-/// @param interval is the multiplier of that repeat frequency to the next
+/// @param[in] interval is the multiplier of that repeat frequency to the next
 ///     event.
 /// @returns a time_t value which is the incremental interval, and would be added
 ///     to a reference time.
@@ -151,11 +145,11 @@
 /// specified Event, it will evaluate the recurring events that may also fall into
 /// the target time range.
 ///
-/// @param start1 is the starting time of range 1.
-/// @param end1 is the ending time of range 1.
-/// @param start2 is the starting time of range 2.
-/// @param end2 is the ending time of range 2.
-/// @param Event is the event of interest that may have recurring series.
+/// @param[in,out] start1 is the starting time of range 1.
+/// @param[in,out] end1 is the ending time of range 1.
+/// @param[in] start2 is the starting time of range 2.
+/// @param[in] end2 is the ending time of range 2.
+/// @param[in] Event is the event of interest that may have recurring series.
 /// @returns true if the ranges overlap, and then start1 and end1 are set to the
 ///     intersection.
 ///