Changeset 16102 for trunk/FACT++/scripts/doc

Timestamp:

05/24/13 13:36:21 (11 years ago)

Author:

tbretz

Message:

Added a user supplied 'this' argument to v8.timeout and the Thread class.

Location:

trunk/FACT++/scripts/doc

Files:

• Thread.js (modified) (2 diffs)
• v8.js (modified) (3 diffs)

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

@@ -35 +35 @@
  *    A function which is executed aftr the initial timeout.
  *
+ * @param {Object} [_this]
+ *    An object which will be the reference for 'this' in the function call.
+ *    If none is given, the function itself will be the 'this' object.
+ *
  * @throws
  *    <li> If number or type of arguments is wrong
@@ -43 +47 @@
  *    handle.kill();
  */
-function Thread(timeout, function)
+function Thread(timeout, function, _this)
 {
     /**

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

@@ -31 +31 @@
  * main purpose of a loop is, e.g., to wait for something to happen.
  *
- * @param {Integer} [milliseconds]
+ * @param {Integer} milliseconds
  *     Number of millliseconds until the timeout. Note that even 0
  *     will execute the function at least once. If the timeout
@@ -37 +37 @@
  *     be returned in case of a timeout.
  *
- * @param {Function} [func]
+ * @param {Function} func
  *     A function. The function defines when the conditional to end
  *     the timeout will be fullfilled. As soon as the function returns
@@ -43 +43 @@
  *     timeout is stopped and its return value is returned.
  *
+ * @param {Object} [_this]
+ *    An object which will be the reference for 'this' in the function call.
+ *    If none is given, the function itself will be the 'this' object.
+ *
  * @param [. . .]
- *     Any further argument will be passed to the function.
+ *     Any further argument will be passed as argument to the function.
  *
  * @returns