Merge pull request #210 from ktopley-apple/dispatch-time-0-doc
Adding documentation to clarify the result of DispatchTime(uptimeNanoseconds: 0)
diff --git a/src/swift/Time.swift b/src/swift/Time.swift
index 46a71d6..af31f6c 100644
--- a/src/swift/Time.swift
+++ b/src/swift/Time.swift
@@ -37,6 +37,12 @@
/// - uptimeNanoseconds: The number of nanoseconds since boot, excluding
/// time the system spent asleep
/// - Returns: A new `DispatchTime`
+ /// - Discussion: This clock is the same as the value returned by
+ /// `mach_absolute_time` when converted into nanoseconds.
+ /// Note that `DispatchTime(uptimeNanoseconds: 0)` is
+ /// equivalent to `DispatchTime.now()`, that is, its value
+ /// represents the number of nanoseconds since boot (excluding
+ /// system sleep time), not zero nanoseconds since boot.
public init(uptimeNanoseconds: UInt64) {
self.rawValue = dispatch_time_t(uptimeNanoseconds)
}
