Skip to content

Commit

Permalink
Documented SDWebImageDownloaderOperation initWithRequest:options:prog…
Browse files Browse the repository at this point in the history
…ress:completed:cancelled: method. Fixes #526
  • Loading branch information
bpoplauschi committed Jun 12, 2014
1 parent fe48ee5 commit 3284e15
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions SDWebImage/SDWebImageDownloaderOperation.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@
@property (strong, nonatomic, readonly) NSURLRequest *request;
@property (assign, nonatomic, readonly) SDWebImageDownloaderOptions options;

/**
* Initializes a `SDWebImageDownloaderOperation` object
*
* @see SDWebImageDownloaderOperation
*
* @param request the URL request
* @param options downloader options
* @param progressBlock the block executed when a new chunk of data arrives.
* @note the progress block is executed on a background queue
* @param completedBlock the block executed when the download is done.
* @note the completed block is executed on the main queue for success. If errors are found, there is a chance the block will be executed on a background queue
* @param cancelBlock the block executed if the download (operation) is cancelled
*
* @return the initialized instance
*/
- (id)initWithRequest:(NSURLRequest *)request
options:(SDWebImageDownloaderOptions)options
progress:(SDWebImageDownloaderProgressBlock)progressBlock
Expand Down

0 comments on commit 3284e15

Please sign in to comment.