Changeset 15142 for trunk/FACT++

Timestamp:

03/23/13 20:10:14 (12 years ago)

Author:

tbretz

Message:

Updated description of wait.

File:

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

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

@@ -123 +123 @@
  *
  * @param {Integer} [timeout]
- *     An optional timeout. If no timeout is given, waiting will not stop
- *     until the condition is fulfilled. A timeout of 0 is allowed and
- *     will essentially just check if the server is in this state or not.
- *     If a negative value is given, exceptions are suppressed and false
- *     is returned in case of timeout. As timeout the absolute value is used.
+ *     An optional timeout. If no timeout is given or a timeout of null,
+ *     waiting will not stop until the condition is fulfilled. A timeout
+ *     of 0 is allowed and will essentially just check if the server is
+ *     in this state or not. If a negative value is given, exceptions are
+ *     suppressed and false is returned in case of timeout. As timeout
+ *     the absolute value is used.
  *
  * @throws