Clarified header documentation for RKRequest's cancel method.

This commit is contained in:
Greg Combs
2011-09-13 10:53:19 -05:00
parent fc5f2b38be
commit 20fb9043b3

View File

@@ -285,9 +285,12 @@ typedef enum RKRequestBackgroundPolicy {
/**
* Cancels the underlying URL connection.
* This will send the requestDidCancel: delegate method
* if your delegate responds to it. It then nils out the delegate
* to ensure no more messages are sent to it.
* This will call the requestDidCancel: delegate method
* if your delegate responds to it. This does not subsequently
* set the the request's delegate to nil. However, it's good
* practice to cancel the RKRequest and immediately set the
* delegate property to nil within the delegate's dealloc method.
* @see NSURLConnection:cancel
*/
- (void)cancel;