Changeset 14995 for trunk/FACT++

Timestamp:

03/09/13 11:02:19 (12 years ago)

Author:

tbretz

Message:

Added some missing text for dim.wait

File:

• trunk/FACT++/scripts/doc/dim.js (modified) (2 diffs)

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

@@ -126 +126 @@
  *     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
@@ -131 +133 @@
  *    <li> If no connection to the server is established or no state
  *         has been received yet. This is identical to dim.state()
- *         returning 'undefined'.
+ *         returning 'undefined' (only in case a positive timeout 
+ *         is given)
  *
  * @returns {Boolean}