Add appledoc, fix some documentation

Author: Joey Lorich

EasyReader.xcodeproj/project.pbxproj

@@ -7,13 +7,13 @@
 //
 
 #import "CSFeedUpdateService.h"
-#import "CSFeedItemUpdater.h"
+#import "EZRFeedItemUpdateService.h"
 
 @implementation CSFeedUpdateService
 
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 {
-    CSFeedItemUpdater *updater = [[CSFeedItemUpdater alloc]  init];
+    EZRFeedItemUpdateService *updater = [[EZRFeedItemUpdateService alloc]  init];
     [updater start];
 
     return YES;

EasyReader/Application/AppDelegates/CSFeedUpdateService.m

@@ -62,12 +62,19 @@ -(NSUInteger)supportedInterfaceOrientations {
 -(BOOL)shouldAutorotate {
     return NO;
 }
-
+//
+//typedef returnType (^void)(parameterTypes);
+//
+//- (configureFeedItemCell)configureFeedItem
+//- (void) blockForSelector
+//{
+//                           }
 /**
  * Assigns observers for feeds and feed items, puts page controller at start
  */
 - (void) setupFeedItemObserver
 {
+    
     [self observeRelationship:@keypath(self.currentUser.feeds)
                   changeBlock:^(__weak CSHomeViewController *self, NSSet *old, NSSet *new) {
                       NSMutableArray *addedFeeds = [[new allObjects] mutableCopy];

EasyReader/Application/Controllers/Home/CSHomeViewController.m

@@ -8,6 +8,14 @@
 
 #import <Foundation/Foundation.h>
 
-@interface CSFeedItemUpdater : NSObject
+/**
+ * A service that polls for feed item update every few minutes
+ */
+@interface EZRFeedItemUpdateService : NSObject
+
+/**
+ * Starts the feed update service
+ */
 - (void) start;
+
 @end

…ader/Application/Api/CSFeedItemUpdater.h …tion/Services/EZRFeedItemUpdateService.hEasyReader/Application/Api/CSFeedItemUpdater.h renamed to EasyReader/Application/Services/EZRFeedItemUpdateService.h EasyReader/Application/Api/CSFeedItemUpdater.h renamed to EasyReader/Application/Services/EZRFeedItemUpdateService.h

@@ -6,16 +6,15 @@
 //  Copyright (c) 2014 Cloudspace. All rights reserved.
 //
 
-#import "CSFeedItemUpdater.h"
+#import "EZRFeedItemUpdateService.h"
 #import "FeedItem.h"
 #import "Feed.h"
 #import "User.h"
 
-@implementation CSFeedItemUpdater
+@implementation EZRFeedItemUpdateService
 
 - (void) start
 {
-    
     if (![self hasSetDefaultFeeds])
     {
         [self loadDefaultFeeds];
@@ -25,7 +24,7 @@ - (void) start
         [self requestOneWeekOfFeedItems];
     }
 
-    NSMethodSignature *mySignature = [CSFeedItemUpdater
+    NSMethodSignature *mySignature = [EZRFeedItemUpdateService
                                       instanceMethodSignatureForSelector:@selector(requestFiveMinutesOfFeedItems:)];
 
     NSInvocation *myInvocation = [NSInvocation

…ader/Application/Api/CSFeedItemUpdater.m …tion/Services/EZRFeedItemUpdateService.mEasyReader/Application/Api/CSFeedItemUpdater.m renamed to EasyReader/Application/Services/EZRFeedItemUpdateService.m EasyReader/Application/Api/CSFeedItemUpdater.m renamed to EasyReader/Application/Services/EZRFeedItemUpdateService.m

@@ -25,14 +25,27 @@
 
 #import <Foundation/Foundation.h>
 
-typedef enum {
+/// Signifies http request method types
+typedef NS_ENUM(NSInteger, APIRequestMethod) {
+    
+    /// Signifies an http GET API request
     kAPIRequestMethodGET,
+    
+    /// Signifies an http POST request
     kAPIRequestMethodPOST,
+    
+    /// Signifies an http PUT request
     kAPIRequestMethodPUT,
+    
+    /// Signifies an http PATCH request
     kAPIRequestMethodPATCH,
+    
+    /// Signifies an http DELETE request
     kAPIRequestMethodDELETE,
+    
+    /// Signifies an http HEAD request
     kAPIRequestMethodHEAD
-} APIRequestMethod;
+};
 
 
 /**
@@ -67,7 +80,7 @@ typedef enum {
 /**
  * Builds a URL String for a given set of parameters
  *
- * @param params The URL Parameters
+ * @param parameters The URL Parameters
  */
 - (NSString *)pathStringForParameters:(NSDictionary *)parameters;
 

EasyReader/Library/apikit/APIRoute.h

@@ -1,8 +1,8 @@
 iOS-EasyReader
-==============
+===
 
 Project Setup Instructions
---------------------------
+---
 
 1. Install xcode
 2. Get the repo