ios / yh_sdwebimage · Commits

Go to a project

Authored by Fernando Saragoca
Committed by Olivier Poitrey
Commit 0dfb649faf2048a3cbef8829fe28cf0f9ab23d2e 1 parent b3d7a5c4

Documented categories (appledoc)

Inline Side-by-side
Showing 2 changed files with 53 additions and 0 deletions
@@ -11,8 +11,29 @@ @@ -11,8 +11,29 @@
11 11
12 @interface UIButton (WebCache) <SDWebImageManagerDelegate> 12 @interface UIButton (WebCache) <SDWebImageManagerDelegate>
13 13
  14 +/**
  15 + * Set the imageView `image` with an `url`.
  16 + *
  17 + * The downloand is asynchronous and cached.
  18 + *
  19 + * @param url The url that the image is found.
  20 + * @see setImageWithURL:placeholderImage:
  21 + */
14 - (void)setImageWithURL:(NSURL *)url; 22 - (void)setImageWithURL:(NSURL *)url;
  23 +
  24 +/**
  25 + * Set the imageView `image` with an `url` and a placeholder.
  26 + *
  27 + * The downloand is asynchronous and cached.
  28 + *
  29 + * @param url The url that the `image` is found.
  30 + * @param placeholder A `image` that will be visible while loading the final image.
  31 + */
15 - (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder; 32 - (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder;
  33 +
  34 +/**
  35 + * Cancel the current download
  36 + */
16 - (void)cancelCurrentImageLoad; 37 - (void)cancelCurrentImageLoad;
17 38
18 @end 39 @end
@@ -12,9 +12,41 @@ @@ -12,9 +12,41 @@
12 12
13 @interface UIImageView (WebCache) <SDWebImageManagerDelegate> 13 @interface UIImageView (WebCache) <SDWebImageManagerDelegate>
14 14
  15 +/**
  16 + * Set the imageView `image` with an `url`.
  17 + *
  18 + * The downloand is asynchronous and cached.
  19 + *
  20 + * @param url The url that the image is found.
  21 + * @see setImageWithURL:placeholderImage:
  22 + */
15 - (void)setImageWithURL:(NSURL *)url; 23 - (void)setImageWithURL:(NSURL *)url;
  24 +
  25 +/**
  26 + * Set the imageView `image` with an `url` and a placeholder.
  27 + *
  28 + * The downloand is asynchronous and cached.
  29 + *
  30 + * @param url The url that the `image` is found.
  31 + * @param placeholder A `image` that will be visible while loading the final image.
  32 + * @see setImageWithURL:placeholderImage:options:
  33 + */
16 - (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder; 34 - (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder;
  35 +
  36 +/**
  37 + * Set the imageView `image` with an `url`, placeholder and custom options.
  38 + *
  39 + * The downloand is asynchronous and cached.
  40 + *
  41 + * @param url The url that the `image` is found.
  42 + * @param placeholder A `image` that will be visible while loading the final image.
  43 + * @param options A list of `SDWebImageOptions` for current `imageView`. Available options are `SDWebImageRetryFailed`, `SDWebImageLowPriority` and `SDWebImageCacheMemoryOnly`.
  44 + */
17 - (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options; 45 - (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options;
  46 +
  47 +/**
  48 + * Cancel the current download
  49 + */
18 - (void)cancelCurrentImageLoad; 50 - (void)cancelCurrentImageLoad;
19 51
20 @end 52 @end