Fix typo in documentation page

This commit is contained in:
kinarob 2019-05-10 21:47:32 +08:00
parent 0783287f95
commit 8a8e527dea
15 changed files with 31 additions and 22 deletions

View File

@ -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)

View File

@ -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 <SDAnimatedImage>

View File

@ -100,7 +100,7 @@
@end
/**
The built-in disk cache
The built-in disk cache.
*/
@interface SDDiskCache : NSObject <SDDiskCache>
/**

View File

@ -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 <SDImageCache>

View File

@ -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

View File

@ -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

View File

@ -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.

View File

@ -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 <NSObject>
- (nullable NSData *)cacheDataWithImage:(nonnull UIImage *)image originalData:(nullable NSData *)data imageURL:(nullable NSURL *)imageURL;

View File

@ -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 <NSObject>
@ -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 <SDWebImageIndicator>
@ -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 <SDWebImageIndicator>

View File

@ -44,7 +44,7 @@ typedef void(^SDInternalCompletionBlock)(UIImage * _Nullable image, NSData * _Nu
@class SDWebImageManager;
/**
The manager delegate protocol
The manager delegate protocol.
*/
@protocol SDWebImageManagerDelegate <NSObject>

View File

@ -8,14 +8,14 @@
#import <Foundation/Foundation.h>
/// A protocol represents cancelable operation
/// A protocol represents cancelable operation.
@protocol SDWebImageOperation <NSObject>
- (void)cancel;
@end
/// NSOperation conform to `SDWebImageOperation`
/// NSOperation conform to `SDWebImageOperation`.
@interface NSOperation (SDWebImageOperation) <SDWebImageOperation>
@end

View File

@ -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)

View File

@ -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)

View File

@ -9,7 +9,7 @@
#import "SDWebImageCompat.h"
/**
UIImage category for memory cache cost
UIImage category for memory cache cost.
*/
@interface UIImage (MemoryCacheCost)

View File

@ -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