From 771e74fdc4a0ffa986cb1d474707ff8c9b017ccc Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Mon, 30 Nov 2009 17:40:32 -0600 Subject: [PATCH] add docs to monotonic-clock --- .../monotonic-clock-docs.factor | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 basis/monotonic-clock/monotonic-clock-docs.factor diff --git a/basis/monotonic-clock/monotonic-clock-docs.factor b/basis/monotonic-clock/monotonic-clock-docs.factor new file mode 100644 index 0000000000..735dbcab40 --- /dev/null +++ b/basis/monotonic-clock/monotonic-clock-docs.factor @@ -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"