Browse Source

Documentation thing

onevcat 9 years ago
parent
commit
68964729ef
2 changed files with 3 additions and 1 deletions
  1. 1 1
      Sources/ImageProcessor.swift
  2. 2 0
      Sources/ImageSerializer.swift

+ 1 - 1
Sources/ImageProcessor.swift

@@ -37,7 +37,7 @@ public enum ImageProcessItem {
     case data(Data)
     case data(Data)
 }
 }
 
 
-/// An `ImageProcessor` could be used to convert some downloaded data to an image.
+/// An `ImageProcessor` would be used to convert some downloaded data to an image.
 public protocol ImageProcessor {
 public protocol ImageProcessor {
     /// Identifier of the processor. It will be used to identify the processor when 
     /// Identifier of the processor. It will be used to identify the processor when 
     /// caching and retriving an image. You might want to make sure that processors with
     /// caching and retriving an image. You might want to make sure that processors with

+ 2 - 0
Sources/ImageSerializer.swift

@@ -26,6 +26,8 @@
 
 
 import Foundation
 import Foundation
 
 
+/// An `CacheSerializer` would be used to convert some data to an image object for 
+/// retrieving from disk cache or vice versa for storing to disk cache.
 public protocol CacheSerializer {
 public protocol CacheSerializer {
     func data(with image: Image, original: Data?) -> Data?
     func data(with image: Image, original: Data?) -> Data?
     func image(with data: Data, options: KingfisherOptionsInfo?) -> Image?
     func image(with data: Data, options: KingfisherOptionsInfo?) -> Image?