Improve documentation

freerangecode · Oct 12, 2011 · b069597 · b069597
1 parent 326bece
commit b069597
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/FRCParentTableViewDataSource.h b/FRCParentTableViewDataSource.h
@@ -36,8 +36,11 @@
 
 #import "FRCTableViewDataSource.h"
 
-
-/** This is an abstract class that implements forwarding of the UITableViewDataSource methods to child data source objects.
+/** This is an abstract class that implements forwarding of the UITableViewDataSource methods to child data source 
+ objects. You should use a subclass or make your own parent subclass, which must implement all of the methods declared
+ here.
+ 
+ Examples of concrete subclasses are FRCSplitTableViewDataSource and FRCCollapsableSectionTableViewDataSource.
 */
 @interface FRCParentTableViewDataSource : FRCTableViewDataSource
 

diff --git a/FRCTableViewDataSource.h b/FRCTableViewDataSource.h
@@ -51,7 +51,11 @@
 
 @class FRCParentTableViewDataSource;
 
-/** An abstract class to represent a core FRCTableViewDataSource object.
+/** An abstract class to represent a core FRCTableViewDataSource object. Examples of concrete 
+ subclasses are FRCObjectTableViewDataSource and FRCFetchedResultsTableViewDataSource.
+ 
+ When subclassing, generally you should write your own implmentation for the objectAtIndexPath:
+ and reloadData methods.
  */
 @interface FRCTableViewDataSource : NSObject <UITableViewDataSource>
 

diff --git a/UITableView+FRCTableViewDataSources.m b/UITableView+FRCTableViewDataSources.m
@@ -125,7 +125,7 @@ - (void)frc_registerFRCTableViewCellSubclass:(Class)tableViewCellClass {
 	UINib *nib = [UINib nibWithNibName:nibName bundle:nil];
 	NSString *reuseIdentifier = [tableViewCellClass reuseIdentifier];
 
-	[self registerNib:nib forCellReuseIdentifier:reuseIdentifier];
+	[self registerNib:nib forCellReuseIdentifier:reuseIdentifier];			
 }
 
 @end