Skip to content

Commit 124a87b

Browse files
author
BB9z
committed
Fix some document error.
1 parent ff2b30e commit 124a87b

File tree

3 files changed

+14
-9
lines changed

3 files changed

+14
-9
lines changed

SDWebImage/SDWebImageDownloader.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ typedef void(^SDWebImageDownloaderCompletedBlock)(UIImage *image, NSData *data,
8282
*
8383
* @param url The URL to the image to download
8484
* @param options The options to be used for this download
85-
* @param progress A block called repeatedly while the image is downloading
86-
* @param completed A block called once the download is completed.
85+
* @param progressBlock A block called repeatedly while the image is downloading
86+
* @param completedBlock A block called once the download is completed.
8787
* If the download succeeded, the image parameter is set, in case of error,
8888
* error parameter is set with the error. The last parameter is always YES
8989
* if SDWebImageDownloaderProgressiveDownload isn't use. With the

SDWebImage/SDWebImageManager.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,6 @@ typedef void(^SDWebImageCompletedWithFinishedBlock)(UIImage *image, NSError *err
131131
* Downloads the image at the given URL if not present in cache or return the cached version otherwise.
132132
*
133133
* @param url The URL to the image
134-
* @param delegate The delegate object used to send result back
135134
* @param options A mask to specify options to use for this request
136135
* @param progressBlock A block called while image is downloading
137136
* @param completedBlock A block called when operation has been completed.

SDWebImage/UIButton+WebCache.h

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,10 @@
134134
*
135135
* @param url The url for the image.
136136
* @param state The state that uses the specified title. The values are described in UIControlState.
137-
* @param success A block to be executed when the image request succeed This block has no return value and takes the retrieved image as argument.
138-
* @param failure A block object to be executed when the image request failed. This block has no return value and takes the error object describing the network or parsing error that occurred (may be nil).
137+
* @param completedBlock A block object to be executed after the request operation
138+
* completed. This block has no return value and takes three argument: the requested
139+
* `UIImage` object, the `NSError` object describing error that occurred, and an
140+
* `SDImageCacheType` enum describing the source of the image obtained from.
139141
*/
140142
- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state completed:(SDWebImageCompletedBlock)completedBlock;
141143

@@ -147,8 +149,10 @@
147149
* @param url The url for the image.
148150
* @param state The state that uses the specified title. The values are described in UIControlState.
149151
* @param placeholder The image to be set initially, until the image request finishes.
150-
* @param success A block to be executed when the image request succeed This block has no return value and takes the retrieved image as argument.
151-
* @param failure A block object to be executed when the image request failed. This block has no return value and takes the error object describing the network or parsing error that occurred (may be nil).
152+
* @param completedBlock A block object to be executed after the request operation
153+
* completed. This block has no return value and takes three argument: the requested
154+
* `UIImage` object, the `NSError` object describing error that occurred, and an
155+
* `SDImageCacheType` enum describing the source of the image obtained from.
152156
*/
153157
- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder completed:(SDWebImageCompletedBlock)completedBlock;
154158

@@ -160,8 +164,10 @@
160164
* @param url The url for the image.
161165
* @param placeholder The image to be set initially, until the image request finishes.
162166
* @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
163-
* @param success A block to be executed when the image request succeed This block has no return value and takes the retrieved image as argument.
164-
* @param failure A block object to be executed when the image request failed. This block has no return value and takes the error object describing the network or parsing error that occurred (may be nil).
167+
* @param completedBlock A block object to be executed after the request operation
168+
* completed. This block has no return value and takes three argument: the requested
169+
* `UIImage` object, the `NSError` object describing error that occurred, and an
170+
* `SDImageCacheType` enum describing the source of the image obtained from.
165171
*/
166172
- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options completed:(SDWebImageCompletedBlock)completedBlock;
167173

0 commit comments

Comments
 (0)