Documentation formatting and touch ups

This commit is contained in:
Blake Watters
2012-09-29 17:42:58 -04:00
parent 42cdcce76e
commit 0539aeb45e
7 changed files with 136 additions and 66 deletions

View File

@@ -5,20 +5,32 @@
// Created by Jeff Arena on 1/24/12.
// Copyright (c) 2009-2012 RestKit. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#import "RKManagedObjectCaching.h"
/**
Provides a fast managed object cache where-in object instances are retained in
memory to avoid hitting the Core Data persistent store. Performance is greatly
increased over fetch request based strategy at the expense of memory consumption.
Provides a fast managed object cache where-in object instances are retained in memory to avoid hitting the Core Data persistent store. Performance is greatly increased over fetch request based strategy at the expense of memory consumption.
*/
@interface RKInMemoryManagedObjectCache : NSObject <RKManagedObjectCaching>
///---------------------------
/// @name Initializing a Cache
///---------------------------
/**
Initializes the receiver with a managed object context that is to be observed
and used to populate the in memory cache. The receiver may then be used to fulfill
cache requests for child contexts of the given managed object context.
Initializes the receiver with a managed object context that is to be observed and used to populate the in memory cache. The receiver may then be used to fulfill cache requests for child contexts of the given managed object context.
@param managedObjectContext The managed object context with which to initialize the receiver.
@return The receiver, initialized with the given managed object context.