Appledoc warning fixes

This commit is contained in:
Blake Watters
2012-09-13 07:27:48 -04:00
parent f457f16dca
commit ef0462ec2a
5 changed files with 8 additions and 5 deletions

View File

@@ -36,7 +36,7 @@
@param entity The Core Data entity description for the managed objects being cached.
@param attributeName The name of an attribute within the cached entity that acts as the cache key.
@param managedObjectContext The managed object context the cache retrieves the cached
@param context The managed object context the cache retrieves the cached
objects from
@return The receiver, initialized with the given entity, attribute, and managed object
context.
@@ -143,6 +143,7 @@
in a given managed object context.
@param attributeValue A value for the cache key attribute.
@param context The managed object context to retrieve the object from.
@return An object with the value of attribute matching attributeValue or nil.
*/
- (NSManagedObject *)objectWithAttributeValue:(id)attributeValue inContext:(NSManagedObjectContext *)context;
@@ -152,6 +153,7 @@
in a given managed object context.
@param attributeValue A value for the cache key attribute.
@param context The managed object context to retrieve the objects from.
@return An array of objects with the value of attribute matching attributeValue or
an empty array.
*/

View File

@@ -25,7 +25,7 @@
/**
An `RKRequestDescriptor` object describes an object mapping configuration that is used to construct the parameters of an HTTP request for an object. Request descriptors are defined by specifying the `RKMapping` object that is to be used when object mapping an object into an `NSDictionary` of parameters, the class of the type of object for which the mapping is to be applied, and an optional root key path under which the paramters are to be nested. Response descriptors are only utilized when construct parameters for an `NSURLRequest` with an HTTP method of `POST`, `PUT`, or `PATCH`.
@see RKParameterization
@see RKObjectParameterization
@see [RKObjectMapping requestMapping]
@see [RKObjectManager requestWithObject:method:path:parameters:]
*/
@@ -76,6 +76,7 @@
/**
Returns `YES` if the given object is instance of objectClass or any class that inherits from objectClass, else `NO`.
@param object The object to be matched against the receiver.
@return `YES` if the given object matches objectClass, else `NO`.
*/
- (BOOL)matchesObject:(id)object;

View File

@@ -63,7 +63,7 @@
/**
Creates and returns a new relationship route object with the given relationship name, object class, path pattern and method.
@param relationshipName The name of the relationship represented by the route.
@param name The name of the relationship represented by the route.
@param objectClass The class containing the relationship represented by the route.
@param pathPattern A SOCKit pattern describing the format of URL paths generated from the route.
@param method The request method of the route.

View File

@@ -106,7 +106,7 @@
no serialization implementation is found to handle the given MIME Type, nil is returned and the given
error pointer will be set to an NSError object with the `RKMissingSerializationForMIMETypeError` code.
@param data The UTF-8 encoded data representation of the object to be deserialized.
@param object The Foundation object to serialized.
@param MIMEType The MIME Type of the serialization format the data is in.
@param error A pointer to an NSError object.
@return A Foundation object from the serialized data in data, or nil if an error occurs.

View File

@@ -93,7 +93,7 @@
@param fixtureName The name of the resource file.
@return A new image object for the specified file, or nil if the method could not initialize the image from the specified file.
@see RKParserRegistry
@see `RKMIMETypeSerialization`
*/
+ (id)parsedObjectWithContentsOfFixture:(NSString *)fixtureName;