Browse Source

Merge pull request #931 from manojmahapatra/patch1

updated comments for init methods
Wei Wang 7 years ago
parent
commit
b4d2bb3b33
3 changed files with 1 additions and 9 deletions
  1. 0 2
      Sources/ImageCache.swift
  2. 0 2
      Sources/ImageDownloader.swift
  3. 1 5
      Sources/ImagePrefetcher.swift

+ 0 - 2
Sources/ImageCache.swift

@@ -131,8 +131,6 @@ open class ImageCache {
                       the `.cachesDirectory` in of your app will be used.
                       the `.cachesDirectory` in of your app will be used.
     - parameter diskCachePathClosure: Closure that takes in an optional initial path string and generates
     - parameter diskCachePathClosure: Closure that takes in an optional initial path string and generates
                       the final disk cache path. You could use it to fully customize your cache path.
                       the final disk cache path. You could use it to fully customize your cache path.
-    
-    - returns: The cache object.
     */
     */
     public init(name: String,
     public init(name: String,
                 path: String? = nil,
                 path: String? = nil,

+ 0 - 2
Sources/ImageDownloader.swift

@@ -284,8 +284,6 @@ open class ImageDownloader {
     Init a downloader with name.
     Init a downloader with name.
     
     
     - parameter name: The name for the downloader. It should not be empty.
     - parameter name: The name for the downloader. It should not be empty.
-    
-    - returns: The downloader object.
     */
     */
     public init(name: String) {
     public init(name: String) {
         if name.isEmpty {
         if name.isEmpty {

+ 1 - 5
Sources/ImagePrefetcher.swift

@@ -86,8 +86,6 @@ public class ImagePrefetcher {
      - parameter progressBlock:     Called every time an resource is downloaded, skipped or cancelled.
      - parameter progressBlock:     Called every time an resource is downloaded, skipped or cancelled.
      - parameter completionHandler: Called when the whole prefetching process finished.
      - parameter completionHandler: Called when the whole prefetching process finished.
      
      
-     - returns: An `ImagePrefetcher` object.
-     
      - Note: By default, the `ImageDownloader.defaultDownloader` and `ImageCache.defaultCache` will be used as 
      - Note: By default, the `ImageDownloader.defaultDownloader` and `ImageCache.defaultCache` will be used as 
      the downloader and cache target respectively. You can specify another downloader or cache by using a customized `KingfisherOptionsInfo`.
      the downloader and cache target respectively. You can specify another downloader or cache by using a customized `KingfisherOptionsInfo`.
      Both the progress and completion block will be invoked in main thread. The `CallbackDispatchQueue` in `optionsInfo` will be ignored in this method.
      Both the progress and completion block will be invoked in main thread. The `CallbackDispatchQueue` in `optionsInfo` will be ignored in this method.
@@ -112,9 +110,7 @@ public class ImagePrefetcher {
      - parameter options:           A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
      - parameter options:           A dictionary could control some behaviors. See `KingfisherOptionsInfo` for more.
      - parameter progressBlock:     Called every time an resource is downloaded, skipped or cancelled.
      - parameter progressBlock:     Called every time an resource is downloaded, skipped or cancelled.
      - parameter completionHandler: Called when the whole prefetching process finished.
      - parameter completionHandler: Called when the whole prefetching process finished.
-     
-     - returns: An `ImagePrefetcher` object.
-     
+
      - Note: By default, the `ImageDownloader.defaultDownloader` and `ImageCache.defaultCache` will be used as
      - Note: By default, the `ImageDownloader.defaultDownloader` and `ImageCache.defaultCache` will be used as
      the downloader and cache target respectively. You can specify another downloader or cache by using a customized `KingfisherOptionsInfo`.
      the downloader and cache target respectively. You can specify another downloader or cache by using a customized `KingfisherOptionsInfo`.
      Both the progress and completion block will be invoked in main thread. The `CallbackDispatchQueue` in `optionsInfo` will be ignored in this method.
      Both the progress and completion block will be invoked in main thread. The `CallbackDispatchQueue` in `optionsInfo` will be ignored in this method.