Fix merge conflicts, update comments

Author: Joey Lorich

EasyReader/Application/Models/Feed.h

@@ -12,16 +12,39 @@
 
 @class FeedItem, User;
 
+/**
+ * An RSS Feed
+ */
 @interface Feed : CSBaseObject
 
+
+#pragma mark - Core Data Properties
+
+/// This feed's icon
 @property (nonatomic, retain) NSString * icon;
+
+/// This feed's name
 @property (nonatomic, retain) NSString * name;
+
+/// This feed's RSS url
 @property (nonatomic, retain) NSString * url;
+
+/// The remote ID of this feed object on the API
 @property (nonatomic, retain) NSNumber * id;
+
+/// The user this feed is associated to
 @property (nonatomic, retain) User *user;
+
+/// The items in this feed
 @property (nonatomic, retain) NSSet *feedItems;
+
+
 @end
 
+
+/**
+ * Core data generated accessor category
+ */
 @interface Feed (CoreDataGeneratedAccessors)
 
 - (void)addFeedItemsObject:(FeedItem *)value;

EasyReader/Application/Models/FeedItem.h

@@ -12,23 +12,62 @@
 
 @class Feed;
 
+/**
+ * A single feed item in a feed
+ */
 @interface FeedItem : CSBaseObject
 
+
+#pragma mark - Core Data Properties
+
+/// The article title for this feed item
 @property (nonatomic, retain) NSString * title;
+
+/// The summary for this feed item
 @property (nonatomic, retain) NSString * summary;
+
+/// /// The time this feed item was updated
 @property (nonatomic, retain) NSDate * updatedAt;
+
+/// The time this feed item's article was published
 @property (nonatomic, retain) NSDate * publishedAt;
+
+/// The time this feed item was created
 @property (nonatomic, retain) NSDate * createdAt;
+
+/// The image for this feed item
 @property (nonatomic, retain) NSString * image;
+
+/// The article URL for this feed item
 @property (nonatomic, retain) NSString * url;
+
+/// This feed items remote API id
 @property (nonatomic, retain) NSNumber * id;
+
+/// The feed this item is in
 @property (nonatomic, retain) Feed *feed;
 
-- (NSString *)headline;
 
+#pragma mark - Properties
+
+/// The appropriate headline for this article
+@property (readonly) NSString *headline;
+
+
+#pragma mark - API methods
+
+/**
+ * Requests new feed items from a group of feeds
+ *
+ * @param feeds
+ * @param startAt
+ * @param success A block to be run on API call success
+ * @param failure A block to be run on API call failure
+ */
 + (void) requestFeedItemsFromFeeds:(NSSet *)feeds
                              Since:(NSDate *)startAt
                            success:(void(^)(NSDictionary *data))successBlock
                            failure:(void(^)(NSDictionary *data))failureBlock;
 
+
 @end

EasyReader/Application/Models/FeedItem.m

@@ -34,14 +34,11 @@ - (NSString *)feedName
   return feed.name;
 }
 
-- (NSString *)timeAgo
-{
-    return [self.updatedAt timeAgo];
-}
-
 - (NSString *)headline
 {
-    return[NSString stringWithFormat:@"%@ \u00b7 %@",[self feedName],[self timeAgo]];
+    NSString *timeAgo = [self.updatedAt timeAgo];
+    
+    return[NSString stringWithFormat:@"%@ \u00b7 %@", self.feed.name, timeAgo];
 }
 
 + (void) requestFeedItemsFromFeeds:(NSSet  *)feeds