Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Small header file changes for Appledoc output changes

  • Loading branch information...
commit b946fc3cd97e7cdcff5f5b645300b9acee658126 1 parent 20fb904
@blakewatters blakewatters authored
View
3  Code/Network/RKRequest.h
@@ -72,6 +72,9 @@ typedef enum RKRequestBackgroundPolicy {
@class RKResponse, RKRequestQueue;
@protocol RKRequestDelegate;
+/**
+ Models the request portion of an HTTP request/response cycle.
+ */
@interface RKRequest : NSObject {
NSURL* _URL;
NSMutableURLRequest* _URLRequest;
View
7 Code/Network/RKRequestCache.h
@@ -9,7 +9,6 @@
#import "RKRequest.h"
#import "RKResponse.h"
-
/**
* Storage policy. Determines if we clear the cache out when the app is shut down.
* Cache instance needs to register for
@@ -20,7 +19,9 @@ typedef enum {
RKRequestCacheStoragePolicyPermanently // Cache data permanently, until explicitly expired or flushed
} RKRequestCacheStoragePolicy;
-
+/**
+ Stores and retrieves cache entries for RestKit request objects.
+ */
@interface RKRequestCache : NSObject {
NSString* _cachePath;
RKRequestCacheStoragePolicy _storagePolicy;
@@ -40,8 +41,6 @@ typedef enum {
- (void)storeResponse:(RKResponse*)response forRequest:(RKRequest*)request;
-//- (void)storeResponse:(RKResponse*)response forRequest:(RKRequest*)request expires:(NSTimeInterval)expirationAge;
-
- (RKResponse*)responseForRequest:(RKRequest*)request;
- (NSDictionary*)headersForRequest:(RKRequest*)request;
View
3  Code/Network/RKResponse.h
@@ -9,6 +9,9 @@
#import <Foundation/Foundation.h>
#import "RKRequest.h"
+/**
+ Models the response portion of an HTTP request/response cycle.
+ */
@interface RKResponse : NSObject {
RKRequest* _request;
NSHTTPURLResponse* _httpURLResponse;
View
5 Code/Network/RKURL.h
@@ -6,6 +6,11 @@
// Copyright 2010 Two Toasters. All rights reserved.
//
+/**
+ Extends the Cocoa NSURL base class to provide support for the concepts
+ of base URL and resource path that are used extensively throughout the RestKit
+ system.
+ */
@interface RKURL : NSURL {
NSString* _baseURLString;
NSString* _resourcePath;
View
4 Code/Support/NSString+RestKit.h
@@ -50,7 +50,7 @@
This method originally appeared as queryContentsUsingEncoding: in the Three20 project:
https://github.com/facebook/three20/blob/master/src/Three20Core/Sources/NSStringAdditions.m
- @param receiver A string in the form of @"/object/?sortBy=name", or @"/object/?sortBy=name&color=red"
+ @param receiver A string in the form of @"/object/?sortBy=name", or @"/object/?sortBy=name&amp;color=red"
@param encoding The encoding for to use while parsing the query string.
@return A new dictionary of query parameters, with keys like 'sortBy' and values like 'name'.
*/
@@ -64,7 +64,7 @@
This method originally appeared as queryContentsUsingEncoding: in the Three20 project:
https://github.com/facebook/three20/blob/master/src/Three20Core/Sources/NSStringAdditions.m
- @param receiver A string in the form of @"/object?sortBy=name", or @"/object?sortBy=name&color=red"
+ @param receiver A string in the form of @"/object?sortBy=name", or @"/object?sortBy=name&amp;color=red"
@param shouldUseArrays If NO, it yields the same results as queryParametersUsingEncoding:, otherwise it creates value arrays instead of value strings.
@param encoding The encoding for to use while parsing the query string.
@return A new dictionary of query parameters, with keys like 'sortBy' and value arrays (if requested) like ['name'].
Please sign in to comment.
Something went wrong with that request. Please try again.