Skip to content

Commit

Permalink
Merge pull request onevcat#931 from manojmahapatra/patch1
Browse files Browse the repository at this point in the history
updated comments for init methods
  • Loading branch information
onevcat authored Jun 15, 2018
2 parents f237bdf + b1ec662 commit 2642474
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 9 deletions.
2 changes: 0 additions & 2 deletions Sources/ImageCache.swift
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,6 @@ open class ImageCache {
the `.cachesDirectory` in of your app will be used.
- 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.

- returns: The cache object.
*/
public init(name: String,
path: String? = nil,
Expand Down
2 changes: 0 additions & 2 deletions Sources/ImageDownloader.swift
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,6 @@ open class ImageDownloader {
Init a downloader with name.

- parameter name: The name for the downloader. It should not be empty.

- returns: The downloader object.
*/
public init(name: String) {
if name.isEmpty {
Expand Down
6 changes: 1 addition & 5 deletions Sources/ImagePrefetcher.swift
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ public class ImagePrefetcher {
- parameter progressBlock: Called every time an resource is downloaded, skipped or cancelled.
- 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
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.
Expand All @@ -112,9 +110,7 @@ public class ImagePrefetcher {
- 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 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
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.
Expand Down

0 comments on commit 2642474

Please sign in to comment.