Docs touch ups

This commit is contained in:
Blake Watters
2012-09-21 22:57:54 -04:00
parent 6815ba6444
commit 43be066e0b
7 changed files with 9 additions and 20 deletions

View File

@@ -85,14 +85,14 @@
/**
The target object for the object mapping operation performed on the deserialized response data. May be nil.
When object mapping is being performed against a known object, the targetObject is set to ensure that the mapping is applied to the appropriate object reference. When nil, the mapping operation will result in the fetching or creation of new objects as necessary to satisfy the mapping configuration.
When object mapping is being performed against a known object, the targetObject is set to ensure that the mapping is applied to the appropriate object reference. When `nil`, the mapping operation will result in the fetching or creation of new objects as necessary to satisfy the mapping configuration.
*/
@property (nonatomic, strong) id targetObject;
/**
The data source for the `RKMappingOperation` instances created by the operation to perform the mapping work.
May be nil depending on the subclass implementation requirements.
May be `nil` depending on the subclass implementation requirements.
@see `RKMappingOperationDataSource`
*/
@@ -106,17 +106,13 @@
@property (nonatomic, weak) id<RKMapperOperationDelegate> mapperDelegate;
/**
A Boolean value that indicates if the receiver should consider empty
responses as being successfully mapped even though no mapping is actually performed.
A Boolean value that indicates if the receiver should consider empty responses as being successfully mapped even though no mapping is actually performed.
When YES and the response data is empty (see below), a mapping result will be returned containing the
target object (if any). Otherwise, the response data will be pass through to the parser which may generate
an error.
When YES and the response data is empty (see below), a mapping result will be returned containing the target object (if any). Otherwise, the response data will be pass through to the parser which may generate an error.
**Default:** YES
@warning To support the Ruby on Rails behavior of rendering a single space character on invocation of
`render :nothing => true`, a response body's containing only a single space is treated as empty.
@warning To support the Ruby on Rails behavior of rendering a single space character on invocation of `render :nothing => true`, a response body's containing only a single space is treated as empty.
*/
@property (nonatomic, assign) BOOL treatsEmptyResponseAsSuccess;

View File

@@ -21,7 +21,7 @@
#import "RKHTTPUtilities.h"
/**
The RKRoute class models a single routable path pattern in use by the application. A route can be combined with an `NSURL` base URL and interpolated with an object to produce a new fully hydrated URL object. Routes are always instantiated with a path pattern and metadata to provide for the subsequent identification of the defined route.
The `RKRoute` class models a single routable path pattern in use by the application. A route can be combined with an `NSURL` base URL and interpolated with an object to produce a new fully hydrated URL object. Routes are always instantiated with a path pattern and metadata to provide for the subsequent identification of the defined route.
There are three types of routes modeled by the RKRoute class:

View File

@@ -88,10 +88,4 @@
*/
- (NSUInteger)count;
/**
TODO: Consider alternate names...
- array | arrayValue
- dictionary | dictionaryValue
- object | firstObject
*/
@end

View File

@@ -65,6 +65,7 @@
///------------------------------------------------------
/// @name Retrieving the Properties and Types for a Class
///------------------------------------------------------
/**
Returns the name of a property when provided the name of a property obtained via the `property_getAttributes` reflection API.

View File

@@ -39,5 +39,4 @@
return tokens;
}
@end

View File

@@ -21,8 +21,7 @@
#import <Foundation/Foundation.h>
/**
Provides convenience methods for accessing data in resources
within an NSBundle.
Provides convenience methods for accessing data in resources within an `NSBundle`.
*/
@interface NSBundle (RKAdditions)

View File

@@ -1667,8 +1667,8 @@
252EFB1F14D9A8D4004863C8 /* Testing */ = {
isa = PBXGroup;
children = (
253477F515FFBD2E002C0E4E /* NSBundle+RKAdditions.m */,
253477F615FFBD2E002C0E4E /* NSBundle+RKAdditions.h */,
253477F515FFBD2E002C0E4E /* NSBundle+RKAdditions.m */,
25055B8214EEF32A00B9C4DD /* RKTestFactory.h */,
25055B8314EEF32A00B9C4DD /* RKTestFactory.m */,
25FABED414E37A2B00E609E7 /* RKTestResponseLoader.h */,