Initial implementation of documentation generation using the Appledoc parser. refs #48

* Cleaned up various mismatches in method signatures that were preventing documentation generation
* Removed naked ampersands from comments as they cause XML parser failures during docset generation via appledoc
This commit is contained in:
Blake Watters
2011-04-13 23:52:28 -04:00
parent 7d85a2bf4d
commit 9af6a59c79
13 changed files with 49 additions and 20 deletions

View File

@@ -150,7 +150,7 @@
/**
* If this loader is bound to a particular object, then we map
* the results back into the instance. This is used for loading and updating
* individual object instances via getObject & friends.
* individual object instances via getObject and friends.
*/
NSArray* results = nil;
if (self.targetObject) {

View File

@@ -192,7 +192,7 @@ typedef enum {
/**
* Returns an object loader configured for transmitting an object instance across the wire. A request will be constructed
* for you with the resource path & object serialization configured for you by the Router. This is the best place to
* for you with the resource path & object serialization configured for you by the Router. This is the best place to
* begin work if you need a slightly different interaction with the server than what is provided for you by get/post/put/delete
* object family of methods. Note that this should be used for one-off changes. If you need to substantially modify all your
* object loads, you are better off subclassing or implementing your own RKRouter for dryness.

View File

@@ -48,7 +48,7 @@
/**
* Must return a new autoreleased instance of the model class ready for mapping. Used to initialize the model
* via any method other than alloc & init.
* via any method other than alloc & init.
*/
+ (id)object;

View File

@@ -135,7 +135,7 @@ typedef enum {
* Returns mapped model(s) from the data serialized in the dictionary into the model instance
* provided
*/
- (id)mapObjectFromDictionary:(NSDictionary*)dictionary;
- (NSObject<RKObjectMappable>*)mapObjectFromDictionary:(NSDictionary*)dictionary;
/**
* Constructs an array of mapped model objects from an array of dictionaries
@@ -150,7 +150,7 @@ typedef enum {
* Map the objects in a given payload string to a particular object class, optionally filtering
* the parsed result set via a keyPath before mapping the results.
*/
- (NSObject<RKObjectMappable>*)mapFromString:(NSString *)string toClass:(Class<RKObjectMappable>)class keyPath:(NSString*)keyPath;
- (id)mapFromString:(NSString *)string toClass:(Class<RKObjectMappable>)class keyPath:(NSString*)keyPath;
/**
* Map a dictionary of elements to an instance of a particular class

View File

@@ -29,8 +29,8 @@ static const NSString* kRKModelMapperRailsDateFormatString = @"MM/dd/yyyy";
- (Class)typeClassForProperty:(NSString*)property ofClass:(Class)class;
- (NSDictionary*)elementToPropertyMappingsForModel:(id)model;
- (id)findOrCreateInstanceOfModelClass:(Class)class fromElements:(NSDictionary*)elements;
- (id)createOrUpdateInstanceOfModelClass:(Class)class fromElements:(NSDictionary*)elements;
- (NSObject<RKObjectMappable>*)findOrCreateInstanceOfModelClass:(Class)class fromElements:(NSDictionary*)elements;
- (NSObject<RKObjectMappable>*)createOrUpdateInstanceOfModelClass:(Class)class fromElements:(NSDictionary*)elements;
- (void)updateModel:(id)model ifNewPropertyValue:(id)propertyValue forPropertyNamed:(NSString*)propertyName; // Rename!
- (void)updateModel:(id)model fromElements:(NSDictionary*)elements;
@@ -203,7 +203,7 @@ static const NSString* kRKModelMapperRailsDateFormatString = @"MM/dd/yyyy";
}
}
- (NSObject<RKObjectMappable>*)mapObjectFromDictionary:(NSDictionary*)dictionary toClass:(Class)class {
- (id)mapObjectFromDictionary:(NSDictionary*)dictionary toClass:(Class)class {
return [self createOrUpdateInstanceOfModelClass:class fromElements:dictionary];
}