Skip to content

Commit

Permalink
Small documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Conrad Stoll committed Jun 27, 2014
1 parent c4b5513 commit a1e8b73
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
5 changes: 4 additions & 1 deletion Source/MMRecord/MMRecordDebugger.h
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,10 @@ typedef NS_ENUM(NSInteger, MMRecordErrorCode) {
*/
- (NSError *)primaryError;

// Way to provide access to every single error thrown by MMRecord
/**
Way to provide access to every single error thrown by MMRecord.
@return NSArray an array of errors encountered while handling the response.
*/
- (NSArray *)errorsEncounteredWhileHandlingResponse;

/**
Expand Down
3 changes: 2 additions & 1 deletion Source/MMRecord/MMRecordMarshaler.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
@class MMRecord;
@class MMRecordProtoRecord;

/** This class is the main sheriff in town for populating an instance of MMRecord. This class holds
/**
This class is the main sheriff in town for populating an instance of MMRecord. This class holds
no state but takes as parameters the proto records which hold all of the information necesary to
populate the record that they hold. This class is meant to be subclassed, although this is the base
implementation of the marshaler. The class that will be used to marshal a record of a given type of
Expand Down
1 change: 0 additions & 1 deletion Source/MMRecord/MMServer.h
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,6 @@ typedef void (^MMServerSessionTimeoutBlock)(MMServerSessionTimeoutRestartLastReq
@param data A dictionary containing request parameters.
@return A configured NSURLRequest.
*/

+ (NSURLRequest *)requestWithURN:(NSString *)URN
data:(NSDictionary *)data;

Expand Down
2 changes: 2 additions & 0 deletions Source/MMRecord/MMServerPageManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
#import <Foundation/Foundation.h>

#import "MMRecord.h"


/**
`MMServerPageManager` encapsulates the logic for representing the current page from a given
request's response. Further, it provides access to the next and previous pages via the URN's to
Expand Down

0 comments on commit a1e8b73

Please sign in to comment.