| 1 | throw new Error("Description for built in functions. Must not be included!");
|
|---|
| 2 | /**
|
|---|
| 3 | * @fileOverview
|
|---|
| 4 | * Documentation of dim namespace.
|
|---|
| 5 | */
|
|---|
| 6 |
|
|---|
| 7 | /**
|
|---|
| 8 | * @namespace
|
|---|
| 9 | *
|
|---|
| 10 | * Namespace for general extension functions
|
|---|
| 11 | *
|
|---|
| 12 | * @author <a href="mailto:thomas.bretz@epfl.ch">Thomas Bretz</a>
|
|---|
| 13 | */
|
|---|
| 14 | var v8 = { };
|
|---|
| 15 |
|
|---|
| 16 | /**
|
|---|
| 17 | * Sleep for a while. This can be used to just wait or give time
|
|---|
| 18 | * back to the operating system to produce less CPU load if the
|
|---|
| 19 | * main purpose of a loop is, e.g., to wait for something to happen.
|
|---|
| 20 | *
|
|---|
| 21 | * @param {Integer} [milliseconds=0]
|
|---|
| 22 | * Number of millliseconds to sleep. Note that even 0 will always
|
|---|
| 23 | * sleep at least one millisecond.
|
|---|
| 24 | *
|
|---|
| 25 | */
|
|---|
| 26 | v8.sleep = function() { /* [native code] */ }
|
|---|
| 27 |
|
|---|
| 28 | /**
|
|---|
| 29 | * This function implements a simple timeout functionality.
|
|---|
| 30 | * back to the operating system to produce less CPU load if the
|
|---|
| 31 | * main purpose of a loop is, e.g., to wait for something to happen.
|
|---|
| 32 | *
|
|---|
| 33 | * @param {Integer} milliseconds
|
|---|
| 34 | * Number of millliseconds until the timeout. Note that even 0
|
|---|
| 35 | * will execute the function at least once. If the timeout
|
|---|
| 36 | * is negative no exception will be thrown by undefined will
|
|---|
| 37 | * be returned in case of a timeout.
|
|---|
| 38 | *
|
|---|
| 39 | * @param {Function} func
|
|---|
| 40 | * A function. The function defines when the conditional to end
|
|---|
| 41 | * the timeout will be fullfilled. As soon as the function returns
|
|---|
| 42 | * a defined value, i.e. something else than undefined, the
|
|---|
| 43 | * timeout is stopped and its return value is returned.
|
|---|
| 44 | *
|
|---|
| 45 | * @param {Object} [_this]
|
|---|
| 46 | * An object which will be the reference for 'this' in the function call.
|
|---|
| 47 | * If none is given, the function itself will be the 'this' object.
|
|---|
| 48 | *
|
|---|
| 49 | * @param [. . .]
|
|---|
| 50 | * Any further argument will be passed as argument to the function.
|
|---|
| 51 | *
|
|---|
| 52 | * @returns
|
|---|
| 53 | * Whatever is returned by the function. undefined in case of timeout
|
|---|
| 54 | * and a negative timeout value.
|
|---|
| 55 | *
|
|---|
| 56 | * @throws
|
|---|
| 57 | * <li> When the number or type of argument is wrong
|
|---|
| 58 | * <li> In case the timeout is positive and the timeout condition occurs
|
|---|
| 59 | *
|
|---|
| 60 | */
|
|---|
| 61 | v8.timeout = function() { /* [native code] */ }
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Version number of the V8 JavaScript engine.
|
|---|
| 65 | *
|
|---|
| 66 | * @constant
|
|---|
| 67 | * @type String
|
|---|
| 68 | */
|
|---|
| 69 | v8.version = "";
|
|---|
