Merge pull request #71 from hyerra/master

Fix Documentation Names to Stop Xcode Warnings

Author: wtmoose

TLIndexPathTools/Controllers/TLIndexPathController.h

@@ -60,7 +60,8 @@ extern NSString * kTLIndexPathUpdatesKey;
  it can be replaced with a model containing a "no results" item.
  
  @param controller  the index path controller that sent the message.
- @param updates  the updates object that can be used to perform batch updates on a table or collection view.
+ @param oldDataModel the old data model used before the update.
+ @param updatedDataModel the new data model returned after the update.
  @returns an alternative data model to use instead of `updatedDataModel` or `nil` to use `updatedDataModel`
  
  */
@@ -167,7 +168,7 @@ extern NSString * kTLIndexPathUpdatesKey;
 /**
  Returns an index path controller initialized with the given items.
  
- @param items  the aray of items
+ @param items  the array of items
  @return the index path controller with a default data model representation of the given items
  
  A default data model is initialized with items where the properties `identifierKeyPath`,
@@ -187,15 +188,15 @@ extern NSString * kTLIndexPathUpdatesKey;
  Returns an index path controller initialized with the given fetch request and
  configuration parameters.
  
- @param fetchRequest
- @param context
- @param sectionNameKeyPath
- @param identifierKeyPath
- @param cacheName
+ @param fetchRequest the fetch request used to do the fetching
+ @param context the managed object context used to fetch objects
+ @param sectionNameKeyPath the key path on the fetched objects used to determine the section they belong to
+ @param identifierKeyPath how the identifier should be generated
+ @param cacheName the name of the file used to cache section information
  @return the index path controller with a default data model representation of the given fetch request
  
  */
-- (instancetype)initWithFetchRequest:(NSFetchRequest *)fetchRequest managedObjectContext:(NSManagedObjectContext *)context sectionNameKeyPath:(NSString * __nullable)sectionNameKeyPath identifierKeyPath:(NSString * __nullable)identifierKeyPath cacheName:(NSString * __nullable)name;
+- (instancetype)initWithFetchRequest:(NSFetchRequest *)fetchRequest managedObjectContext:(NSManagedObjectContext *)context sectionNameKeyPath:(NSString * __nullable)sectionNameKeyPath identifierKeyPath:(NSString * __nullable)identifierKeyPath cacheName:(NSString * __nullable)cacheName;
 
 #pragma mark - Configuration information
 /** @name Configuration information */
@@ -283,7 +284,7 @@ extern NSString * kTLIndexPathUpdatesKey;
  fetch request (and perform fetch), in-memory sort descriptors, and in-memory
  predicate as a single update.
  
- @param udpates  a block that makes changes to the controller
+ @param updates  a block that makes changes to the controller
  @param completion  a block to be executed after the batch updates are performed.
         Note that controller:didUpdateDataModel: is called before this block.
  

TLIndexPathTools/Controllers/TLIndexPathController.m

@@ -61,13 +61,13 @@ - (instancetype)initWithDataModel:(TLIndexPathDataModel *)dataModel
     return self;
 }
 
-- (id)initWithFetchRequest:(NSFetchRequest *)fetchRequest managedObjectContext:(NSManagedObjectContext *)context sectionNameKeyPath:(NSString *)sectionNameKeyPath identifierKeyPath:(NSString *)identifierKeyPath cacheName:(NSString *)name
+- (id)initWithFetchRequest:(NSFetchRequest *)fetchRequest managedObjectContext:(NSManagedObjectContext *)context sectionNameKeyPath:(NSString *)sectionNameKeyPath identifierKeyPath:(NSString *)identifierKeyPath cacheName:(NSString *)cacheName
 {
     TLIndexPathDataModel *dataModel = [[TLIndexPathDataModel alloc] initWithItems:@[] sectionNameKeyPath:sectionNameKeyPath identifierKeyPath:identifierKeyPath];
     if (self = [self initWithDataModel:dataModel]) {
         //initialize the backing controller with nil sectionNameKeyPath because we don't require
         //items to be sorted by section, but NSFetchedResultsController does.
-        _backingController = [[NSFetchedResultsController alloc] initWithFetchRequest:fetchRequest managedObjectContext:context sectionNameKeyPath:sectionNameKeyPath cacheName:name];
+        _backingController = [[NSFetchedResultsController alloc] initWithFetchRequest:fetchRequest managedObjectContext:context sectionNameKeyPath:sectionNameKeyPath cacheName:cacheName];
         _backingController.delegate = self;
     }
     return self;