Skip to content

Commit 73a9ff0

Browse files
committed
Update some of the documentations
1 parent 95bfc40 commit 73a9ff0

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

SDWebImageSwiftUI/Classes/AnimatedImage.swift

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -489,9 +489,11 @@ extension AnimatedImage {
489489
}
490490

491491
/// Provide a max buffer size by bytes. This is used to adjust frame buffer count and can be useful when the decoding cost is expensive (such as Animated WebP software decoding). Default is nil.
492-
// `0` or nil means automatically adjust by calculating current memory usage.
493-
// `1` means without any buffer cache, each of frames will be decoded and then be freed after rendering. (Lowest Memory and Highest CPU)
494-
// `UInt.max` means cache all the buffer. (Lowest CPU and Highest Memory)
492+
///
493+
/// `0` or nil means automatically adjust by calculating current memory usage.
494+
/// `1` means without any buffer cache, each of frames will be decoded and then be freed after rendering. (Lowest Memory and Highest CPU)
495+
/// `UInt.max` means cache all the buffer. (Lowest CPU and Highest Memory)
496+
/// - Warning: watchOS does not implementes.
495497
/// - Parameter bufferSize: The max buffer size
496498
public func maxBufferSize(_ bufferSize: UInt?) -> AnimatedImage {
497499
imageConfiguration.maxBufferSize = bufferSize
@@ -501,6 +503,7 @@ extension AnimatedImage {
501503
/// Whehter or not to enable incremental image load for animated image. See `SDAnimatedImageView` for detailed explanation for this.
502504
/// - Note: If you are confused about this description, open Chrome browser to view some large GIF images with low network speed to see the animation behavior.
503505
/// Default is true. Set to false to only render the static poster for incremental animated image.
506+
/// - Warning: watchOS does not implementes.
504507
/// - Parameter incrementalLoad: Whether or not to incremental load
505508
public func incrementalLoad(_ incrementalLoad: Bool) -> AnimatedImage {
506509
imageConfiguration.incrementalLoad = incrementalLoad

SDWebImageSwiftUI/Classes/SDAnimatedImageInterface.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
#if SD_WATCH
1111
NS_ASSUME_NONNULL_BEGIN
1212

13+
/// Do not use this class directly in WatchKit or Storyboard. This class is implementation detail and will be removed in the future.
1314
@interface SDAnimatedImageInterface : WKInterfaceImage
1415

1516
- (instancetype)init WK_AVAILABLE_WATCHOS_ONLY(6.0);

0 commit comments

Comments
 (0)