Updated high-level comments/documentation

HolidaysDemo/Holiday.h

@@ -1,4 +1,15 @@
+/* 
+ * Copyright (c) 2009 Keith Lazuka
+ * License: http://www.opensource.org/licenses/mit-license.html
+ */
 
+/*
+ *    Holiday
+ *    -------
+ *
+ *  An immutable value object that represents a single element
+ *  in the dataset.
+ */
 @interface Holiday : NSObject
 {
   NSDate *date;

HolidaysDemo/Holiday.m

@@ -1,5 +1,9 @@
-#import "Holiday.h"
+/* 
+ * Copyright (c) 2009 Keith Lazuka
+ * License: http://www.opensource.org/licenses/mit-license.html
+ */
 
+#import "Holiday.h"
 
 @implementation Holiday
 
@@ -36,5 +40,4 @@ - (void)dealloc
   [super dealloc];
 }
 
-
 @end

HolidaysDemo/HolidayAppDelegate.h

@@ -5,6 +5,21 @@
 
 #import <UIKit/UIKit.h>
 
+/*
+ *    HolidayAppDelegate
+ *    ------------------
+ *
+ *  This demo app shows how to use Kal to display 2009 and 2010
+ *  world holidays. I have provided 2 example data sources:
+ *
+ *    1. HolidayJSONDataSource - fetches JSON data from the internet
+ *    2. HolidaySqliteDataSource - queries a local Sqlite database
+ *
+ *  Both data sources use the same logical data and both present
+ *  the data to the user in the same way (via UITableViewCells).
+ *  The only difference is in the way that they retrieve the data.
+ *
+ */
 @interface HolidayAppDelegate : NSObject <UIApplicationDelegate>
 {
   UIWindow *window;
@@ -14,4 +29,3 @@
 @property (nonatomic, retain) IBOutlet UIWindow *window;
 
 @end
-

HolidaysDemo/HolidayAppDelegate.m

@@ -8,12 +8,10 @@
 #import "HolidaySqliteDataSource.h"
 #import "Kal.h"
 
-
 @implementation HolidayAppDelegate
 
 @synthesize window;
 
-
 - (void)applicationDidFinishLaunching:(UIApplication *)application
 {
   // I provide several different dataSource examples. Pick one by commenting out the others.

HolidaysDemo/HolidayJSONDataSource.h

@@ -1,10 +1,20 @@
-/* 
+/*
  * Copyright (c) 2009 Keith Lazuka
  * License: http://www.opensource.org/licenses/mit-license.html
  */
 
 #import "Kal.h"
 
+/*
+ *    HolidayJSONDataSource
+ *    ---------------------
+ *
+ *  This example data source retrieves 2009 and 2010 world holidays
+ *  from a JSON resource located at http://keith.lazuka.org/holidays.json.
+ *  It uses Stig Brautaset's JSON library to parse the JSON and store
+ *  it in an array of Holiday objects.
+ *
+ */
 @interface HolidayJSONDataSource : NSObject <KalDataSource>
 {
   NSMutableArray *items;

HolidaysDemo/HolidayJSONDataSource.m

@@ -1,4 +1,4 @@
-/* 
+/*
  * Copyright (c) 2009 Keith Lazuka
  * License: http://www.opensource.org/licenses/mit-license.html
  */
@@ -164,5 +164,4 @@ - (void)dealloc
   [super dealloc];
 }
 
-
 @end

HolidaysDemo/HolidaySqliteDataSource.h

@@ -1,10 +1,21 @@
-/* 
+/*
  * Copyright (c) 2009 Keith Lazuka
  * License: http://www.opensource.org/licenses/mit-license.html
  */
 
 #import "Kal.h"
 
+/*
+ *    HolidaySqliteDataSource
+ *    ---------------------
+ *
+ *  This example data source retrieves 2009 and 2010 world holidays
+ *  from an Sqlite database stored locally in the application bundle.
+ *  When the presentingDatesFrom:to:delegate message is received,
+ *  it queries the database for the specified date range and
+ *  instantiates a Holiday object for each row in the result set.
+ *
+ */
 @interface HolidaySqliteDataSource : NSObject <KalDataSource>
 {
   NSMutableArray *items;

HolidaysDemo/HolidaySqliteDataSource.m

@@ -1,4 +1,4 @@
-/* 
+/*
  * Copyright (c) 2009 Keith Lazuka
  * License: http://www.opensource.org/licenses/mit-license.html
  */
@@ -132,5 +132,4 @@ - (void)dealloc
   [super dealloc];
 }
 
-
 @end

Kal/KalDataSource.h

@@ -95,4 +95,4 @@
 {
 }
 + (SimpleKalDataSource*)dataSource;
-@end
+@end

Kal/KalGridView.m

@@ -256,5 +256,4 @@ - (void)dealloc
   [super dealloc];
 }
 
-
 @end

Kal/KalLogic.m

@@ -145,5 +145,4 @@ - (void) dealloc
   [super dealloc];
 }
 
-
 @end

Kal/KalPrivate.h

@@ -5,4 +5,3 @@
 
 #import "UIViewAdditions.h"
 #import "NSDateAdditions.h"
-

Kal/KalTileView.m

@@ -196,5 +196,4 @@ - (void)dealloc
   [super dealloc];
 }
 
-
 @end

Kal/KalView.m

@@ -231,22 +231,4 @@ - (void)dealloc
   [super dealloc];
 }
 
-
 @end
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

Kal/KalViewController.h

@@ -33,4 +33,3 @@
 - (void)showAndSelectToday; // Updates the state of the calendar to display today's month and selects the tile for today's date.
 
 @end
-

Kal/KalViewController.m

@@ -100,7 +100,7 @@ - (void)showFollowingMonth
   [self fetchDataForCurrentMonth];
 }
 
-// ----------------------------------------
+// -----------------------------------------
 #pragma mark KalDataSourceCallbacks protocol
 
 - (void)loadedDataSource:(id<KalDataSource>)theDataSource;
@@ -142,19 +142,6 @@ - (void)showAndSelectToday
   [self fetchDataForCurrentMonth];
 }
 
-/*
-- (void)showAndSelectToday
-{
-  if ([[self calendarView] isSliding])
-    return;
-  
-  [logic moveToTodaysMonth];
-  [[self calendarView] jumpToSelectedMonth];
-  [[self calendarView] selectTodayIfVisible];
-  [self fetchDataForCurrentMonth];
-}
- */
-
 // -----------------------------------------------------------------------------------
 #pragma mark UIViewController
 
@@ -190,6 +177,4 @@ - (void)dealloc
   [super dealloc];
 }
 
-
 @end
-

Kal/UIViewAdditions.m

@@ -79,5 +79,4 @@ - (void)setHeight:(CGFloat)height
   self.frame = frame;
 }
 
-
 @end