Merge pull request onevcat#104 from nixzhu/master

fix typo "retriving" -> "retrieving"
pinkski · Sep 8, 2015 · 04caeea · 04caeea
2 parents 04d4f2e + e288ebc
commit 04caeea
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 49 deletions.
diff --git a/Kingfisher/ImageCache.swift b/Kingfisher/ImageCache.swift
@@ -229,10 +229,10 @@ extension ImageCache {
     Get an image for a key from memory or disk.
 
     :param: key               Key for the image.
-    :param: options           Options of retriving image.
+    :param: options           Options of retrieving image.
     :param: completionHandler Called when getting operation completes with image result and cached type of this image. If there is no such key cached, the image will be `nil`.
 
-    :returns: The retriving task.
+    :returns: The retrieving task.
     */
     public func retrieveImageForKey(key: String, options:KingfisherManager.Options, completionHandler: ((UIImage?, CacheType!) -> ())?) -> RetrieveImageDiskTask? {
         // No completion handler. Not start working and early return.

diff --git a/Kingfisher/KingfisherManager.swift b/Kingfisher/KingfisherManager.swift
@@ -105,7 +105,7 @@ public class KingfisherManager {
     :param: resource          Resource object contains information such as `cacheKey` and `downloadURL`.
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: progressBlock     Called every time downloaded data changed. This could be used as a progress UI.
-    :param: completionHandler Called when the whole retriving process finished.
+    :param: completionHandler Called when the whole retrieving process finished.
 
     :returns: A `RetrieveImageTask` task object. You can use this object to cancel the task.
     */
@@ -189,7 +189,7 @@ public class KingfisherManager {
     :param: URL               The image URL.
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: progressBlock     Called every time downloaded data changed. This could be used as a progress UI.
-    :param: completionHandler Called when the whole retriving process finished.
+    :param: completionHandler Called when the whole retrieving process finished.
 
     :returns: A `RetrieveImageTask` task object. You can use this object to cancel the task.
     */

diff --git a/Kingfisher/UIButton+Kingfisher.swift b/Kingfisher/UIButton+Kingfisher.swift
@@ -39,7 +39,7 @@ public extension UIButton {
     :param: resource Resource object contains information such as `cacheKey` and `downloadURL`.
     :param: state The state that uses the specified image.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                   forState state: UIControlState) -> RetrieveImageTask
@@ -57,7 +57,7 @@ public extension UIButton {
     :param: URL   The URL of image for specified state.
     :param: state The state that uses the specified image.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                         forState state: UIControlState) -> RetrieveImageTask
@@ -72,7 +72,7 @@ public extension UIButton {
     :param: state            The state that uses the specified image.
     :param: placeholderImage A placeholder image when retrieving the image at URL.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                   forState state: UIControlState,
@@ -88,7 +88,7 @@ public extension UIButton {
     :param: state            The state that uses the specified image.
     :param: placeholderImage A placeholder image when retrieving the image at URL.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                         forState state: UIControlState,
@@ -105,7 +105,7 @@ public extension UIButton {
     :param: placeholderImage A placeholder image when retrieving the image at URL.
     :param: optionsInfo      A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                   forState state: UIControlState,
@@ -123,7 +123,7 @@ public extension UIButton {
     :param: placeholderImage A placeholder image when retrieving the image at URL.
     :param: optionsInfo      A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                         forState state: UIControlState,
@@ -142,7 +142,7 @@ public extension UIButton {
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                   forState state: UIControlState,
@@ -162,7 +162,7 @@ public extension UIButton {
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                         forState state: UIControlState,
@@ -184,7 +184,7 @@ public extension UIButton {
     :param: progressBlock     Called when the image downloading progress gets updated.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                   forState state: UIControlState,
@@ -223,7 +223,7 @@ public extension UIButton {
     :param: progressBlock     Called when the image downloading progress gets updated.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                         forState state: UIControlState,
@@ -286,7 +286,7 @@ public extension UIButton {
     :param: resource Resource object contains information such as `cacheKey` and `downloadURL`.
     :param: state    The state that uses the specified image.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithResource(resource: Resource,
                                             forState state: UIControlState) -> RetrieveImageTask
@@ -304,7 +304,7 @@ public extension UIButton {
     :param: URL   The URL of image for specified state.
     :param: state The state that uses the specified image.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithURL(URL: NSURL,
                                   forState state: UIControlState) -> RetrieveImageTask
@@ -319,7 +319,7 @@ public extension UIButton {
     :param: state            The state that uses the specified image.
     :param: placeholderImage A placeholder image when retrieving the image at URL.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithResource(resource: Resource,
                                             forState state: UIControlState,
@@ -335,7 +335,7 @@ public extension UIButton {
     :param: state            The state that uses the specified image.
     :param: placeholderImage A placeholder image when retrieving the image at URL.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithURL(URL: NSURL,
                                   forState state: UIControlState,
@@ -352,7 +352,7 @@ public extension UIButton {
     :param: placeholderImage A placeholder image when retrieving the image at URL.
     :param: optionsInfo      A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithResource(resource: Resource,
                                             forState state: UIControlState,
@@ -370,7 +370,7 @@ public extension UIButton {
     :param: placeholderImage A placeholder image when retrieving the image at URL.
     :param: optionsInfo      A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithURL(URL: NSURL,
                                   forState state: UIControlState,
@@ -389,7 +389,7 @@ public extension UIButton {
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithResource(resource: Resource,
                                             forState state: UIControlState,
@@ -409,7 +409,7 @@ public extension UIButton {
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithURL(URL: NSURL,
                                   forState state: UIControlState,
@@ -431,7 +431,7 @@ public extension UIButton {
     :param: progressBlock     Called when the image downloading progress gets updated.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithResource(resource: Resource,
                                             forState state: UIControlState,
@@ -471,7 +471,7 @@ public extension UIButton {
     :param: progressBlock     Called when the image downloading progress gets updated.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setBackgroundImageWithURL(URL: NSURL,
                                   forState state: UIControlState,

diff --git a/Kingfisher/UIImageView+Kingfisher.swift b/Kingfisher/UIImageView+Kingfisher.swift
@@ -40,7 +40,7 @@ public extension UIImageView {
 
     :param: resource Resource object contains information such as `cacheKey` and `downloadURL`.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource) -> RetrieveImageTask
     {
@@ -56,7 +56,7 @@ public extension UIImageView {
 
     :param: URL The URL of image.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL) -> RetrieveImageTask
     {
@@ -69,7 +69,7 @@ public extension UIImageView {
     :param: resource         Resource object contains information such as `cacheKey` and `downloadURL`.
     :param: placeholderImage A placeholder image when retrieving the image at URL.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                 placeholderImage: UIImage?) -> RetrieveImageTask
@@ -83,7 +83,7 @@ public extension UIImageView {
     :param: URL              The URL of image.
     :param: placeholderImage A placeholder image when retrieving the image at URL.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                       placeholderImage: UIImage?) -> RetrieveImageTask
@@ -98,7 +98,7 @@ public extension UIImageView {
     :param: placeholderImage A placeholder image when retrieving the image at URL.
     :param: optionsInfo      A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                 placeholderImage: UIImage?,
@@ -114,7 +114,7 @@ public extension UIImageView {
     :param: placeholderImage A placeholder image when retrieving the image at URL.
     :param: optionsInfo      A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                       placeholderImage: UIImage?,
@@ -131,7 +131,7 @@ public extension UIImageView {
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                 placeholderImage: UIImage?,
@@ -149,7 +149,7 @@ public extension UIImageView {
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                       placeholderImage: UIImage?,
@@ -168,7 +168,7 @@ public extension UIImageView {
     :param: progressBlock     Called when the image downloading progress gets updated.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithResource(resource: Resource,
                                 placeholderImage: UIImage?,
@@ -217,7 +217,7 @@ public extension UIImageView {
     :param: progressBlock     Called when the image downloading progress gets updated.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
 
     public func kf_setImageWithURL(URL: NSURL,

diff --git a/Kingfisher/WKInterfaceImage+Kingfisher.swift b/Kingfisher/WKInterfaceImage+Kingfisher.swift
@@ -38,7 +38,7 @@ public extension WKInterfaceImage {
 
     :param: URL The URL of image.
 
-    :returns: A task represents the retriving process or `nil` if device cache is used.
+    :returns: A task represents the retrieving process or `nil` if device cache is used.
     */
     public func kf_setImageWithURL(URL: NSURL) -> RetrieveImageTask?
     {
@@ -55,7 +55,7 @@ public extension WKInterfaceImage {
     :param: URL              The URL of image.
     :param: placeholderImage A placeholder image when retrieving the image at URL.
 
-    :returns: A task represents the retriving process.
+    :returns: A task represents the retrieving process.
     */
     public func kf_setImageWithURL(URL: NSURL,
                       placeholderImage: UIImage?) -> RetrieveImageTask?
@@ -69,7 +69,7 @@ public extension WKInterfaceImage {
     :param: URL  The URL of image.
     :param: name The name of an image in WatchKit app bundle or the device-side cache.
 
-    :returns: A task represents the retriving process or `nil` if device cache is used.
+    :returns: A task represents the retrieving process or `nil` if device cache is used.
     */
     public func kf_setImageWithURL(URL: NSURL,
             placeholderImageNamed name: String?) -> RetrieveImageTask?
@@ -84,7 +84,7 @@ public extension WKInterfaceImage {
     :param: placeholderImage A placeholder image when retrieving the image at URL.
     :param: optionsInfo      A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
 
-    :returns: A task represents the retriving process or `nil` if device cache is used.
+    :returns: A task represents the retrieving process or `nil` if device cache is used.
     */
     public func kf_setImageWithURL(URL: NSURL,
                       placeholderImage: UIImage?,
@@ -100,7 +100,7 @@ public extension WKInterfaceImage {
     :param: name        The name of an image in WatchKit app bundle or the device-side cache.
     :param: optionsInfo A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
 
-    :returns: A task represents the retriving process or `nil` if device cache is used.
+    :returns: A task represents the retrieving process or `nil` if device cache is used.
     */
     public func kf_setImageWithURL(URL: NSURL,
             placeholderImageNamed name: String?,
@@ -117,7 +117,7 @@ public extension WKInterfaceImage {
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process or `nil` if device cache is used.
+    :returns: A task represents the retrieving process or `nil` if device cache is used.
     */
     public func kf_setImageWithURL(URL: NSURL,
                       placeholderImage: UIImage?,
@@ -135,7 +135,7 @@ public extension WKInterfaceImage {
     :param: optionsInfo       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process or `nil` if device cache is used.
+    :returns: A task represents the retrieving process or `nil` if device cache is used.
     */
     public func kf_setImageWithURL(URL: NSURL,
             placeholderImageNamed name: String?,
@@ -154,7 +154,7 @@ public extension WKInterfaceImage {
     :param: progressBlock     Called when the image downloading progress gets updated.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process or `nil` if device cache is used.
+    :returns: A task represents the retrieving process or `nil` if device cache is used.
     */
     public func kf_setImageWithURL(URL: NSURL,
                       placeholderImage: UIImage?,
@@ -181,7 +181,7 @@ public extension WKInterfaceImage {
     :param: progressBlock     Called when the image downloading progress gets updated.
     :param: completionHandler Called when the image retrieved and set.
 
-    :returns: A task represents the retriving process or `nil` if device cache is used.
+    :returns: A task represents the retrieving process or `nil` if device cache is used.
     */
     public func kf_setImageWithURL(URL: NSURL,
             placeholderImageNamed name: String?,