Changeset 15074 for trunk

Timestamp:

03/15/13 12:20:21 (12 years ago)

Author:

tbretz

Message:

Added the new function v8.timeout

File:

• trunk/FACT++/scripts/doc/v8.js (modified) (1 diff)

trunk/FACT++/scripts/doc/v8.js

@@ -27 +27 @@
 
 /**
+ * This function implements a simple timeout functionality. 
+ * back to the operating system to produce less CPU load if the
+ * main purpose of a loop is, e.g., to wait for something to happen.
+ *
+ * @param {Integer} [milliseconds]
+ *     Number of millliseconds until the timeout. Note that even 0
+ *     will execute the function at least once. If the timeout
+ *     is negative no exception will be thrown by undefined will
+ *     be returned in case of a timeout.
+ *
+ * @param {Function} [func]
+ *     A function. The function defines when the conditional to end
+ *     the timeout will be fullfilled. As soon as the function returns
+ *     a defined value, i.e. something else than undefined, the
+ *     timeout is stopped and its return value is returned.
+ *
+ * @param [. . .]
+ *     Any further argument will be passed to the function.
+ *
+ * @returns
+ *     Whatever is returned by the function. undefined in case of timeout
+ *     and a negative timeout value.
+ *
+ * @throws
+ *     <li> When the number or type of argument is wrong
+ *     <li> In case the timeout is positive and the timeout condition occurs
+ *
+ */
+v8.timeout = function() { /* [native code] */ }
+
+/**
  * Version number of the V8 JavaScript engine.
  *