Skip to content

Commit b63ef65

Browse files
committed
Update the code comments about documentation
1 parent 347a4b1 commit b63ef65

File tree

7 files changed

+9
-2
lines changed

7 files changed

+9
-2
lines changed

SDWebImageYYPlugin/Classes/YYCache/YYCacheBridge/YYCache+SDAdditions.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99
#import <YYCache/YYCache.h>
1010
#import <SDWebImage/SDWebImage.h>
1111

12-
// YYCache category to support `SDImageCache` protocol. This allow user who prefer YYCache to be used as SDWebImage's custom image cache
13-
12+
/// YYCache category to support `SDImageCache` protocol. This allow user who prefer YYCache to be used as SDWebImage's custom image cache
1413
@interface YYCache (SDAdditions) <SDImageCache>
1514

1615
@end

SDWebImageYYPlugin/Classes/YYCache/YYCacheBridge/YYDiskCache+SDAdditions.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
#import <YYCache/YYDiskCache.h>
99
#import <SDWebImage/SDWebImage.h>
1010

11+
/// YYDiskCache category to support `SDDiskCache` protocol. This allow user who prefer YYDiskCache to be used as SDWebImage's custom disk cache
1112
@interface YYDiskCache (SDAdditions) <SDDiskCache>
1213

1314
@end

SDWebImageYYPlugin/Classes/YYCache/YYCacheBridge/YYMemoryCache+SDAdditions.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
#import <YYCache/YYMemoryCache.h>
99
#import <SDWebImage/SDWebImage.h>
1010

11+
/// YYMemoryCache category to support `SDMemoryCache` protocol. This allow user who prefer YYMemoryCache to be used as SDWebImage's custom memory cache
1112
@interface YYMemoryCache (SDAdditions) <SDMemoryCache>
1213

1314
@end

SDWebImageYYPlugin/Classes/YYImage/SDWebImageBridge/SDAnimatedImage+YYAdditions.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
#import <SDWebImage/SDWebImage.h>
99
#import <YYImage/YYAnimatedImageView.h>
1010

11+
/// SDAnimatedImage category to supports `YYAnimatedImage` protocol, which allows using `SDAnimatedImage` inside `YYAnimatedImageView`
1112
@interface SDAnimatedImage (YYAdditions) <YYAnimatedImage>
1213

1314
@end

SDWebImageYYPlugin/Classes/YYImage/YYImageBridge/SDImageYYCoder.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
*/
1515
@interface SDImageYYCoder : NSObject <SDImageCoder, SDProgressiveImageCoder, SDAnimatedImageCoder>
1616

17+
/**
18+
The shared coder instance.
19+
*/
1720
@property (nonatomic, class, readonly, nonnull) SDImageYYCoder *sharedCoder;
1821

1922
/**

SDWebImageYYPlugin/Classes/YYImage/YYImageBridge/YYAnimatedImageView+WebCache.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
#import <YYImage/YYAnimatedImageView.h>
99
#import <SDWebImage/SDWebImage.h>
1010

11+
/// YYAnimatedImageView Category to support load image with SDWebImage loading system.
1112
@interface YYAnimatedImageView (WebCache)
1213

1314
/**

SDWebImageYYPlugin/Classes/YYImage/YYImageBridge/YYImage+SDAdditions.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
#import <YYImage/YYImage.h>
99
#import <SDWebImage/SDWebImage.h>
1010

11+
/// YYImage category to support `SDAnimatedImage` protocol, which allows using `YYImage` inside `SDAnimatedImageView`
1112
@interface YYImage (SDAdditions) <SDAnimatedImage>
1213

1314
@end

0 commit comments

Comments
 (0)