ios / yh_sdwebimage · Commits

Go to a project

Authored by Bogdan Poplauschi
Commit 945f8691ff10099e04d444f54e6487c7e0879e3c 1 parent 267635ee

Fixed documentation warning, param name is `completionBlock`

Inline Side-by-side
Showing 1 changed file with 14 additions and 14 deletions
@@ -98,9 +98,9 @@ typedef void(^SDWebImageCalculateSizeBlock)(NSUInteger fileCount, NSUInteger tot @@ -98,9 +98,9 @@ typedef void(^SDWebImageCalculateSizeBlock)(NSUInteger fileCount, NSUInteger tot
98 /** 98 /**
99 * Asynchronously store an image into memory and disk cache at the given key. 99 * Asynchronously store an image into memory and disk cache at the given key.
100 * 100 *
101 - * @param image The image to store  
102 - * @param key The unique image cache key, usually it's image absolute URL  
103 - * @param completion A block executed after the operation is finished 101 + * @param image The image to store
  102 + * @param key The unique image cache key, usually it's image absolute URL
  103 + * @param completionBlock A block executed after the operation is finished
104 */ 104 */
105 - (void)storeImage:(nullable UIImage *)image 105 - (void)storeImage:(nullable UIImage *)image
106 forKey:(nullable NSString *)key 106 forKey:(nullable NSString *)key
@@ -109,10 +109,10 @@ typedef void(^SDWebImageCalculateSizeBlock)(NSUInteger fileCount, NSUInteger tot @@ -109,10 +109,10 @@ typedef void(^SDWebImageCalculateSizeBlock)(NSUInteger fileCount, NSUInteger tot
109 /** 109 /**
110 * Asynchronously store an image into memory and disk cache at the given key. 110 * Asynchronously store an image into memory and disk cache at the given key.
111 * 111 *
112 - * @param image The image to store  
113 - * @param key The unique image cache key, usually it's image absolute URL  
114 - * @param toDisk Store the image to disk cache if YES  
115 - * @param completion A block executed after the operation is finished 112 + * @param image The image to store
  113 + * @param key The unique image cache key, usually it's image absolute URL
  114 + * @param toDisk Store the image to disk cache if YES
  115 + * @param completionBlock A block executed after the operation is finished
116 */ 116 */
117 - (void)storeImage:(nullable UIImage *)image 117 - (void)storeImage:(nullable UIImage *)image
118 forKey:(nullable NSString *)key 118 forKey:(nullable NSString *)key
@@ -122,13 +122,13 @@ typedef void(^SDWebImageCalculateSizeBlock)(NSUInteger fileCount, NSUInteger tot @@ -122,13 +122,13 @@ typedef void(^SDWebImageCalculateSizeBlock)(NSUInteger fileCount, NSUInteger tot
122 /** 122 /**
123 * Asynchronously store an image into memory and disk cache at the given key. 123 * Asynchronously store an image into memory and disk cache at the given key.
124 * 124 *
125 - * @param image The image to store  
126 - * @param imageData The image data as returned by the server, this representation will be used for disk storage  
127 - * instead of converting the given image object into a storable/compressed image format in order  
128 - * to save quality and CPU  
129 - * @param key The unique image cache key, usually it's image absolute URL  
130 - * @param toDisk Store the image to disk cache if YES  
131 - * @param completion A block executed after the operation is finished 125 + * @param image The image to store
  126 + * @param imageData The image data as returned by the server, this representation will be used for disk storage
  127 + * instead of converting the given image object into a storable/compressed image format in order
  128 + * to save quality and CPU
  129 + * @param key The unique image cache key, usually it's image absolute URL
  130 + * @param toDisk Store the image to disk cache if YES
  131 + * @param completionBlock A block executed after the operation is finished
132 */ 132 */
133 - (void)storeImage:(nullable UIImage *)image 133 - (void)storeImage:(nullable UIImage *)image
134 imageData:(nullable NSData *)imageData 134 imageData:(nullable NSData *)imageData