]> gitweb.factorcode.org Git - factor.git/commitdiff
add docs to monotonic-clock
authorDoug Coleman <doug.coleman@gmail.com>
Mon, 30 Nov 2009 23:40:32 +0000 (17:40 -0600)
committerDoug Coleman <doug.coleman@gmail.com>
Mon, 30 Nov 2009 23:40:32 +0000 (17:40 -0600)
basis/monotonic-clock/monotonic-clock-docs.factor [new file with mode: 0644]

diff --git a/basis/monotonic-clock/monotonic-clock-docs.factor b/basis/monotonic-clock/monotonic-clock-docs.factor
new file mode 100644 (file)
index 0000000..735dbca
--- /dev/null
@@ -0,0 +1,18 @@
+! Copyright (C) 2009 Doug Coleman.
+! See http://factorcode.org/license.txt for BSD license.
+USING: help.markup help.syntax kernel math ;
+IN: monotonic-clock
+
+HELP: monotonic-count
+{ $values
+    
+    { "n" integer }
+}
+{ $description "Returns a monotonically increasing number of nanoseconds since an arbitrary time. This number can be compared against future calls to " { $link monotonic-count } "." } ;
+
+ARTICLE: "monotonic-clock" "Monotonic clock"
+"The " { $vocab-link "monotonic-clock" } " vocabulary implements a single word which can be used as a clock. A special property of this clock is that it is independent of the system time and time zones." $nl
+"Get the number of nanoseconds since an arbitrary beginning:"
+{ $subsections monotonic-count } ;
+
+ABOUT: "monotonic-clock"