Revision 8:87549cc99d5e, committed 2014-10-11

Comitter:

WiredHome

Date:

Sat Oct 11 17:26:20 2014 +0000

Parent:

7:dc132d8bcbfd

Child:

9:2c2c35511965

Commit message:

Documentation updates only.

Changed in this revision

--- a/iCal.cpp	Thu Jul 10 11:01:49 2014 +0000
+++ b/iCal.cpp	Sat Oct 11 17:26:20 2014 +0000
@@ -174,13 +174,13 @@
 /// Computes the intersection of time1 and time2 ranges, and modifies time1
 /// range to represent the intersection.
 ///
-/// @param start1 is input as the start of the time1 range, and is written
+/// start1 is input as the start of the time1 range, and is written
 ///     to represent the intersection of the two ranges.
-/// @param end1 is input as the end of the time1 range and is written to
+/// end1 is input as the end of the time1 range and is written to
 ///     represent the intersection of the two ranges.
-/// @param start2 is the start of the time2 range.
-/// @param end2 is the end of the time2 range.
-/// @returns true if the ranges have an intersection, and the time1 range
+/// start2 is the start of the time2 range.
+/// end2 is the end of the time2 range.
+/// returns true if the ranges have an intersection, and the time1 range
 ///     values have been modified.
 ///
 bool TimeIntersects(time_t * start1, time_t * end1, time_t * start2, time_t * end2)

--- a/iCal.h	Thu Jul 10 11:01:49 2014 +0000
+++ b/iCal.h	Sat Oct 11 17:26:20 2014 +0000
@@ -45,6 +45,7 @@
 typedef int32_t tz_sec_t;
 typedef int16_t tz_min_t;
 
+/// A single event consists of quite a number of attributes.
 typedef struct {
     time_t Start;
     time_t End;
@@ -55,17 +56,15 @@
     uint8_t RepeatDays;             // bit mapped (bit 0 = sunday, bit 1=monday, ...)
     uint16_t RepeatMonths;          // bit mapped (bit 0 = jan, 1=feb, ...)
     uint32_t RepeatMonthDay;        // bit mapped (bit 1 = 1st, 2=2nd, ...)
-    uint32_t RepeatMonthDayRev;   // reverse -1 = last day = bit 1, -2=bit 2, ...
+    uint32_t RepeatMonthDayRev;     // reverse -1 = last day = bit 1, -2=bit 2, ...
     char Summary[SUMMARY_CHARS];
     char Location[LOCATION_CHARS];
-    char Category[CATEGORY_CHARS];     // "Green", ...
-    int Priority;           // 1 == High, 5 == Normal, 9 == Low
+    char Category[CATEGORY_CHARS];  // "Green", ...
+    int Priority;                   // 1 == High, 5 == Normal, 9 == Low
 } Event_T;
 
-
 extern Event_T EventList[EVENT_COUNT];
 
-
 /// Parse an iCal stream, and extract everything useful.
 ///
 /// This accepts a pointer to a [large] buffer, which is the contents