Merge branch 'master' into swift-2.0

# Conflicts: # Kingfisher/ImageCache.swift # Kingfisher/KingfisherManager.swift # Kingfisher/UIButton+Kingfisher.swift # Kingfisher/UIImageView+Kingfisher.swift # Kingfisher/WKInterfaceImage+Kingfisher.swift
pinkski · Sep 8, 2015 · a8309d3 · a8309d3
2 parents 67e3537 + 04caeea
commit a8309d3
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 40 deletions.
diff --git a/Kingfisher/ImageCache.swift b/Kingfisher/ImageCache.swift
@@ -233,10 +233,10 @@ extension ImageCache {
     Get an image for a key from memory or disk.
 
     - parameter key:               Key for the image.
-    - parameter options:           Options of retriving image.
+    - parameter options:           Options of retrieving image.
     - parameter 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
@@ -100,7 +100,7 @@ public class KingfisherManager {
     - parameter resource:          Resource object contains information such as `cacheKey` and `downloadURL`.
     - parameter optionsInfo:       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     - parameter progressBlock:     Called every time downloaded data changed. This could be used as a progress UI.
-    - parameter completionHandler: Called when the whole retriving process finished.
+    - parameter completionHandler: Called when the whole retrieving process finished.
 
     - returns: A `RetrieveImageTask` task object. You can use this object to cancel the task.
     */
@@ -184,7 +184,7 @@ public class KingfisherManager {
     - parameter URL:               The image URL.
     - parameter optionsInfo:       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     - parameter progressBlock:     Called every time downloaded data changed. This could be used as a progress UI.
-    - parameter completionHandler: Called when the whole retriving process finished.
+    - parameter 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 {
     - parameter resource: Resource object contains information such as `cacheKey` and `downloadURL`.
     - parameter 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 {
     - parameter URL:   The URL of image for specified state.
     - parameter 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 {
     - parameter state:            The state that uses the specified image.
     - parameter 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 {
     - parameter state:            The state that uses the specified image.
     - parameter 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 {
     - parameter placeholderImage: A placeholder image when retrieving the image at URL.
     - parameter 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 {
     - parameter placeholderImage: A placeholder image when retrieving the image at URL.
     - parameter 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 {
     - parameter optionsInfo:       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     - parameter 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 {
     - parameter optionsInfo:       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     - parameter 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 {
     - parameter progressBlock:     Called when the image downloading progress gets updated.
     - parameter 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 {
     - parameter progressBlock:     Called when the image downloading progress gets updated.
     - parameter 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 {
     - parameter resource: Resource object contains information such as `cacheKey` and `downloadURL`.
     - parameter 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 {
     - parameter URL:   The URL of image for specified state.
     - parameter 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 {
     - parameter state:            The state that uses the specified image.
     - parameter 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 {
     - parameter state:            The state that uses the specified image.
     - parameter 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 {
     - parameter placeholderImage: A placeholder image when retrieving the image at URL.
     - parameter 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 {
     - parameter placeholderImage: A placeholder image when retrieving the image at URL.
     - parameter 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 {
     - parameter optionsInfo:       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     - parameter 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 {
     - parameter optionsInfo:       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     - parameter 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 {
     - parameter progressBlock:     Called when the image downloading progress gets updated.
     - parameter 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 {
     - parameter progressBlock:     Called when the image downloading progress gets updated.
     - parameter 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 {
 
     - parameter 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 {
 
     - parameter 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 {
     - parameter resource:         Resource object contains information such as `cacheKey` and `downloadURL`.
     - parameter 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 {
     - parameter URL:              The URL of image.
     - parameter 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 {
     - parameter placeholderImage: A placeholder image when retrieving the image at URL.
     - parameter 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 {
     - parameter placeholderImage: A placeholder image when retrieving the image at URL.
     - parameter 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 {
     - parameter optionsInfo:       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     - parameter 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 {
     - parameter optionsInfo:       A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
     - parameter 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 {
     - parameter progressBlock:     Called when the image downloading progress gets updated.
     - parameter 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 {
     - parameter progressBlock:     Called when the image downloading progress gets updated.
     - parameter 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/KingfisherTests/ImageCacheTests.swift b/KingfisherTests/ImageCacheTests.swift
@@ -87,7 +87,7 @@ class ImageCacheTests: XCTestCase {
     }
 
     func testClearMemoryCache() {
-        let expectation = expectationWithDescription("wait for retriving image")
+        let expectation = expectationWithDescription("wait for retrieving image")
 
         cache.storeImage(testImage, forKey: testKeys[0], toDisk: true) { () -> () in
             self.cache.clearMemoryCache()
@@ -101,7 +101,7 @@ class ImageCacheTests: XCTestCase {
     }
 
     func testNoImageFound() {
-        let expectation = expectationWithDescription("wait for retriving image")
+        let expectation = expectationWithDescription("wait for retrieving image")
 
         cache.clearDiskCacheWithCompletionHandler { () -> () in
             self.cache.retrieveImageForKey(testKeys[0], options: KingfisherManager.OptionsNone, completionHandler: { (image, type) -> () in
@@ -115,7 +115,7 @@ class ImageCacheTests: XCTestCase {
     }
 
     func testStoreImageInMemory() {
-        let expectation = expectationWithDescription("wait for retriving image")
+        let expectation = expectationWithDescription("wait for retrieving image")
 
         cache.storeImage(testImage, forKey: testKeys[0], toDisk: false) { () -> () in
             self.cache.retrieveImageForKey(testKeys[0], options: KingfisherManager.OptionsNone, completionHandler: { (image, type) -> () in
@@ -163,9 +163,9 @@ class ImageCacheTests: XCTestCase {
         self.waitForExpectationsWithTimeout(5, handler: nil)
     }
 
-    func testRetrivingImagePerformance() {
+    func testRetrievingImagePerformance() {
 
-        let expectation = self.expectationWithDescription("wait for retriving image")
+        let expectation = self.expectationWithDescription("wait for retrieving image")
         self.cache.storeImage(testImage, forKey: testKeys[0], toDisk: true) { () -> () in
             self.measureBlock({ () -> Void in
                 for _ in 1 ..< 1000 {
@@ -179,7 +179,7 @@ class ImageCacheTests: XCTestCase {
     }
 
     func testCleanDiskCacheNotification() {
-        let expectation = expectationWithDescription("wait for retriving image")
+        let expectation = expectationWithDescription("wait for retrieving image")
 
         cache.storeImage(testImage, forKey: testKeys[0], toDisk: true) { () -> () in