Skip to content
Browse files

Cleaning up more documentation for consistency, and adding more docs!…

… Somebody stop me!
  • Loading branch information...
1 parent 039ed79 commit 6b143980fdd54a2592fe79d92a3ce039d9441f8c @tonyarnold tonyarnold committed May 29, 2014
View
46 MagicalRecord/Categories/NSManagedObjectContext/NSManagedObjectContext+MagicalObserving.h
@@ -10,14 +10,60 @@
extern NSString * const kMagicalRecordDidMergeChangesFromiCloudNotification;
+/**
+ Category methods to aid in observing changes in other contexts.
+
+ @since Available in v2.0 and later.
+ */
@interface NSManagedObjectContext (MagicalObserving)
+/**
+ Merge changes from another context into self.
+
+ @param otherContext Managed object context to observe.
+
+ @since Available in v2.0 and later.
+ */
- (void) MR_observeContext:(NSManagedObjectContext *)otherContext;
+
+/**
+ Stops merging changes from the supplied context into self.
+
+ @param otherContext Managed object context to stop observing.
+
+ @since Available in v2.0 and later.
+ */
- (void) MR_stopObservingContext:(NSManagedObjectContext *)otherContext;
+/**
+ Merges changes from another context into self on the main thread.
+
+ @param otherContext Managed object context to observe.
+
+ @since Available in v2.0 and later.
+ */
- (void) MR_observeContextOnMainThread:(NSManagedObjectContext *)otherContext;
+/**
+ Merges changes from the supplied persistent store coordinator into self in response to changes from iCloud.
+
+ @param coordinator Persistent store coordinator
+
+ @see -MR_stopObservingiCloudChangesInCoordinator:
+
+ @since Available in v2.0 and later.
+ */
- (void) MR_observeiCloudChangesInCoordinator:(NSPersistentStoreCoordinator *)coordinator;
+
+/**
+ Stops observation and merging of changes from the supplied persistent store coordinator in response to changes from iCloud.
+
+ @param coordinator Persistent store coordinator
+
+ @see -MR_observeiCloudChangesInCoordinator:
+
+ @since Available in v2.0 and later.
+ */
- (void) MR_stopObservingiCloudChangesInCoordinator:(NSPersistentStoreCoordinator *)coordinator;
@end

0 comments on commit 6b14398

Please sign in to comment.
Something went wrong with that request. Please try again.