Added comments to DateToTimestampTransformer

Chandlerdea · Dec 3, 2017 · 31c67cf · 31c67cf
1 parent d448f37
commit 31c67cf
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/DateTransfomer/DateToTimestampTransformer.swift b/DateTransfomer/DateToTimestampTransformer.swift
@@ -21,6 +21,11 @@ public final class DateToTimestampTransformer: ValueTransformer {
 
     // MARK: - Public Methods
 
+    /**
+     Transforms a `Date` into a timestamp (3 minutes ago, 1 week ago....)
+     - parameter date: The date, in the past, that the timestamp is referencing
+     - returns: A string timestamp
+    */
     public func transformDate(_ date: Date) -> String? {
         return self.transformedValue(date) as? String
     }