From: Ben Noordhuis <info@bnoordhuis.nl>
Date: Sun, 1 Jul 2012 18:09:55 +0000 (+0200)
Subject: doc: document setTimeout / setInterval behavior
X-Git-Tag: v0.8.2~32
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b53cd9798f96637a8bb60ef2391f21bd017f071d;p=platform%2Fupstream%2Fnodejs.git

doc: document setTimeout / setInterval behavior
---

diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown
index 85bb174..0ca2b0d 100644
--- a/doc/api/globals.markdown
+++ b/doc/api/globals.markdown
@@ -139,10 +139,38 @@ See the [module system documentation][] for more information.
 See the [module section][] for more information.
 
 ## setTimeout(cb, ms)
+
+Run callback `cb` after *at least* `ms` milliseconds. The actual delay depends
+on external factors like OS timer granularity and system load.
+
+The timeout must be in the range of 1-2,147,483,647 inclusive. If the value is
+outside that range, it's changed to 1 millisecond. Broadly speaking, a timer
+cannot span more than 24.8 days.
+
+Returns an opaque value that represents the timer.
+
 ## clearTimeout(t)
+
+Stop a timer that was previously created with `setTimeout()`. The callback will
+not execute.
+
 ## setInterval(cb, ms)
+
+Run callback `cb` repeatedly every `ms` milliseconds. Note that the actual
+interval may vary, depending on external factors like OS timer granularity and
+system load. It's never less than `ms` but it may be longer.
+
+The interval must be in the range of 1-2,147,483,647 inclusive. If the value is
+outside that range, it's changed to 1 millisecond. Broadly speaking, a timer
+cannot span more than 24.8 days.
+
+Returns an opaque value that represents the timer.
+
 ## clearInterval(t)
 
+Stop a timer that was previously created with `setInterval()`. The callback
+will not execute.
+
 <!--type=global-->
 
 The timer functions are global variables. See the [timers][] section.