From 8a8e527dea222f5817a88123f8020954097ed68b Mon Sep 17 00:00:00 2001 From: kinarob Date: Fri, 10 May 2019 21:47:32 +0800 Subject: [PATCH] Fix typo in documentation page --- SDWebImage/NSData+ImageContentType.h | 2 +- SDWebImage/SDAnimatedImage.h | 2 +- SDWebImage/SDDiskCache.h | 2 +- SDWebImage/SDImageCachesManager.h | 2 +- SDWebImage/SDImageCoderHelper.h | 2 +- SDWebImage/SDImageFrame.h | 2 +- SDWebImage/SDImageTransformer.h | 6 ++++++ SDWebImage/SDWebImageCacheSerializer.h | 3 ++- SDWebImage/SDWebImageIndicator.h | 18 ++++++++++-------- SDWebImage/SDWebImageManager.h | 2 +- SDWebImage/SDWebImageOperation.h | 4 ++-- SDWebImage/UIImage+ForceDecode.h | 2 +- SDWebImage/UIImage+GIF.h | 2 +- SDWebImage/UIImage+MemoryCacheCost.h | 2 +- SDWebImage/UIImage+MultiFormat.h | 2 +- 15 files changed, 31 insertions(+), 22 deletions(-) diff --git a/SDWebImage/NSData+ImageContentType.h b/SDWebImage/NSData+ImageContentType.h index 584b2e82..5bbb4ae6 100644 --- a/SDWebImage/NSData+ImageContentType.h +++ b/SDWebImage/NSData+ImageContentType.h @@ -25,7 +25,7 @@ static const SDImageFormat SDImageFormatHEIC = 5; static const SDImageFormat SDImageFormatHEIF = 6; /** - NSData category about the image content type and UTI + NSData category about the image content type and UTI. */ @interface NSData (ImageContentType) diff --git a/SDWebImage/SDAnimatedImage.h b/SDWebImage/SDAnimatedImage.h index 0a1df6ef..9b814900 100644 --- a/SDWebImage/SDAnimatedImage.h +++ b/SDWebImage/SDAnimatedImage.h @@ -60,7 +60,7 @@ @end /** - The image class which supports animating on `SDAnimatedImageView`. You can also use it on normal UIImageView/NSImageView + The image class which supports animating on `SDAnimatedImageView`. You can also use it on normal UIImageView/NSImageView. */ @interface SDAnimatedImage : UIImage diff --git a/SDWebImage/SDDiskCache.h b/SDWebImage/SDDiskCache.h index 93ed2433..ffc440e5 100644 --- a/SDWebImage/SDDiskCache.h +++ b/SDWebImage/SDDiskCache.h @@ -100,7 +100,7 @@ @end /** - The built-in disk cache + The built-in disk cache. */ @interface SDDiskCache : NSObject /** diff --git a/SDWebImage/SDImageCachesManager.h b/SDWebImage/SDImageCachesManager.h index 3e8a0d66..ad85db88 100644 --- a/SDWebImage/SDImageCachesManager.h +++ b/SDWebImage/SDImageCachesManager.h @@ -18,7 +18,7 @@ typedef NS_ENUM(NSUInteger, SDImageCachesManagerOperationPolicy) { }; /** - A caches manager to manage multiple caches + A caches manager to manage multiple caches. */ @interface SDImageCachesManager : NSObject diff --git a/SDWebImage/SDImageCoderHelper.h b/SDWebImage/SDImageCoderHelper.h index 721b97d3..dcf1da2b 100644 --- a/SDWebImage/SDImageCoderHelper.h +++ b/SDWebImage/SDImageCoderHelper.h @@ -11,7 +11,7 @@ #import "SDImageFrame.h" /** - Provide some common helper methods for building the image decoder/encoder + Provide some common helper methods for building the image decoder/encoder. */ @interface SDImageCoderHelper : NSObject diff --git a/SDWebImage/SDImageFrame.h b/SDWebImage/SDImageFrame.h index 72fa840f..a93fd9c8 100644 --- a/SDWebImage/SDImageFrame.h +++ b/SDWebImage/SDImageFrame.h @@ -11,7 +11,7 @@ /** This class is used for creating animated images via `animatedImageWithFrames` in `SDImageCoderHelper`. - @note Attention if you need to specify animated images loop count, use `sd_imageLoopCount` property in `UIImage+Metadata.h`. + @note If you need to specify animated images loop count, use `sd_imageLoopCount` property in `UIImage+Metadata.h`. */ @interface SDImageFrame : NSObject diff --git a/SDWebImage/SDImageTransformer.h b/SDWebImage/SDImageTransformer.h index a9e2e78b..f165cce5 100644 --- a/SDWebImage/SDImageTransformer.h +++ b/SDWebImage/SDImageTransformer.h @@ -78,18 +78,21 @@ FOUNDATION_EXPORT NSString * _Nullable SDTransformedKeyForKey(NSString * _Nullab half the width or height. */ @property (nonatomic, assign, readonly) CGFloat cornerRadius; + /** A bitmask value that identifies the corners that you want rounded. You can use this parameter to round only a subset of the corners of the rectangle. */ @property (nonatomic, assign, readonly) SDRectCorner corners; + /** The inset border line width. Values larger than half the rectangle's width or height are clamped appropriately to half the width or height. */ @property (nonatomic, assign, readonly) CGFloat borderWidth; + /** The border stroke color. nil means clear color. */ @@ -109,6 +112,7 @@ FOUNDATION_EXPORT NSString * _Nullable SDTransformedKeyForKey(NSString * _Nullab The new size to be resized, values should be positive. */ @property (nonatomic, assign, readonly) CGSize size; + /** The scale mode for image content. */ @@ -143,6 +147,7 @@ FOUNDATION_EXPORT NSString * _Nullable SDTransformedKeyForKey(NSString * _Nullab YES to flip the image horizontally. ⇋ */ @property (nonatomic, assign, readonly) BOOL horizontal; + /** YES to flip the image vertically. ⥯ */ @@ -162,6 +167,7 @@ FOUNDATION_EXPORT NSString * _Nullable SDTransformedKeyForKey(NSString * _Nullab Rotated radians in counterclockwise.⟲ */ @property (nonatomic, assign, readonly) CGFloat angle; + /** YES: new image's size is extend to fit all content. NO: image's size will not change, content may be clipped. diff --git a/SDWebImage/SDWebImageCacheSerializer.h b/SDWebImage/SDWebImageCacheSerializer.h index 742b1e4b..84c92a37 100644 --- a/SDWebImage/SDWebImageCacheSerializer.h +++ b/SDWebImage/SDWebImageCacheSerializer.h @@ -13,7 +13,8 @@ typedef NSData * _Nullable(^SDWebImageCacheSerializerBlock)(UIImage * _Nonnull i /** This is the protocol for cache serializer. - We can use a block to specify the cache serializer. But Using protocol can make this extensible, and allow Swift user to use it easily instead of using `@convention(block)` to store a block into context options. */ + We can use a block to specify the cache serializer. But Using protocol can make this extensible, and allow Swift user to use it easily instead of using `@convention(block)` to store a block into context options. + */ @protocol SDWebImageCacheSerializer - (nullable NSData *)cacheDataWithImage:(nonnull UIImage *)image originalData:(nullable NSData *)data imageURL:(nullable NSURL *)imageURL; diff --git a/SDWebImage/SDWebImageIndicator.h b/SDWebImage/SDWebImageIndicator.h index 72d07fc6..3cbea7bd 100644 --- a/SDWebImage/SDWebImageIndicator.h +++ b/SDWebImage/SDWebImageIndicator.h @@ -11,8 +11,8 @@ #if SD_UIKIT || SD_MAC /** - A protocol to custom the indicator during the image loading - All of these methods are called from main queue + A protocol to custom the indicator during the image loading. + All of these methods are called from main queue. */ @protocol SDWebImageIndicator @@ -23,10 +23,12 @@ @return The indicator view */ @property (nonatomic, strong, readonly, nonnull) UIView *indicatorView; + /** Start the animating for indicator. */ - (void)startAnimatingIndicator; + /** Stop the animating for indicator. */ @@ -45,9 +47,9 @@ #pragma mark - Activity Indicator /** - Activity indicator class - for UIKit(macOS), it use a `UIActivityIndicatorView` - for AppKit(macOS), it use a `NSProgressIndicator` with the spinning style + Activity indicator class. + for UIKit(macOS), it use a `UIActivityIndicatorView`. + for AppKit(macOS), it use a `NSProgressIndicator` with the spinning style. */ @interface SDWebImageActivityIndicator : NSObject @@ -78,9 +80,9 @@ #pragma mark - Progress Indicator /** - Progress indicator class - for UIKit(macOS), it use a `UIProgressView` - for AppKit(macOS), it use a `NSProgressIndicator` with the bar style + Progress indicator class. + for UIKit(macOS), it use a `UIProgressView`. + for AppKit(macOS), it use a `NSProgressIndicator` with the bar style. */ @interface SDWebImageProgressIndicator : NSObject diff --git a/SDWebImage/SDWebImageManager.h b/SDWebImage/SDWebImageManager.h index af2e81e5..5e600916 100644 --- a/SDWebImage/SDWebImageManager.h +++ b/SDWebImage/SDWebImageManager.h @@ -44,7 +44,7 @@ typedef void(^SDInternalCompletionBlock)(UIImage * _Nullable image, NSData * _Nu @class SDWebImageManager; /** - The manager delegate protocol + The manager delegate protocol. */ @protocol SDWebImageManagerDelegate diff --git a/SDWebImage/SDWebImageOperation.h b/SDWebImage/SDWebImageOperation.h index f025c0d2..50266db1 100644 --- a/SDWebImage/SDWebImageOperation.h +++ b/SDWebImage/SDWebImageOperation.h @@ -8,14 +8,14 @@ #import -/// A protocol represents cancelable operation +/// A protocol represents cancelable operation. @protocol SDWebImageOperation - (void)cancel; @end -/// NSOperation conform to `SDWebImageOperation` +/// NSOperation conform to `SDWebImageOperation`. @interface NSOperation (SDWebImageOperation) @end diff --git a/SDWebImage/UIImage+ForceDecode.h b/SDWebImage/UIImage+ForceDecode.h index 343f6137..f3687467 100644 --- a/SDWebImage/UIImage+ForceDecode.h +++ b/SDWebImage/UIImage+ForceDecode.h @@ -9,7 +9,7 @@ #import "SDWebImageCompat.h" /** - UIImage category about force decode feature (avoid Image/IO's lazy decoding during rendering behavior) + UIImage category about force decode feature (avoid Image/IO's lazy decoding during rendering behavior). */ @interface UIImage (ForceDecode) diff --git a/SDWebImage/UIImage+GIF.h b/SDWebImage/UIImage+GIF.h index 2887734d..7504c71a 100644 --- a/SDWebImage/UIImage+GIF.h +++ b/SDWebImage/UIImage+GIF.h @@ -10,7 +10,7 @@ #import "SDWebImageCompat.h" /** - This category is just use as a convenience method. For more detail control, use methods in `UIImage+MultiFormat.h` or directlly use `SDImageCoder` + This category is just use as a convenience method. For more detail control, use methods in `UIImage+MultiFormat.h` or directlly use `SDImageCoder`. */ @interface UIImage (GIF) diff --git a/SDWebImage/UIImage+MemoryCacheCost.h b/SDWebImage/UIImage+MemoryCacheCost.h index 371b5b02..5b0fe585 100644 --- a/SDWebImage/UIImage+MemoryCacheCost.h +++ b/SDWebImage/UIImage+MemoryCacheCost.h @@ -9,7 +9,7 @@ #import "SDWebImageCompat.h" /** - UIImage category for memory cache cost + UIImage category for memory cache cost. */ @interface UIImage (MemoryCacheCost) diff --git a/SDWebImage/UIImage+MultiFormat.h b/SDWebImage/UIImage+MultiFormat.h index 51cd46ed..84313344 100644 --- a/SDWebImage/UIImage+MultiFormat.h +++ b/SDWebImage/UIImage+MultiFormat.h @@ -10,7 +10,7 @@ #import "NSData+ImageContentType.h" /** - UIImage category for convenient image format decoding/encoding + UIImage category for convenient image format decoding/encoding. */ @interface UIImage (MultiFormat) #pragma mark - Decode