Changeset 16829 for trunk/FACT++/scripts/doc/dimctrl.js

Timestamp:

06/13/13 20:52:35 (11 years ago)

Author:

tbretz

Message:

Updated.

File:

• trunk/FACT++/scripts/doc/dimctrl.js (modified) (4 diffs)

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

@@ -101 +101 @@
  * event (dim or command interface) will be processed.
  *
+ * If an interrupt was triggered by dimctrl (so not from within
+ * the script) and a number between 10 and 255 is returned,
+ * the state machine will change its state accordingly. Other returned
+ * ojects or returned values outside of this range are ignored.
+ *
  * @param {Function} [func]
  *    Function to be called when an interrupt is received. Null, undefined
@@ -117 +122 @@
  *         for (var key in args)
  *             console.out(" args["+key+"="+args[key]);
+ *
+ *         var newState = 10;
+ *         return newState;
  *     }
  *     dimctrl.setInterruptHandler(handleIrq);
@@ -134 +142 @@
  *     a new line.
  *
+ * @returns
+ *    the return of the interrupt handler which is called is returned
+ *
+ * @throws
+ *    if an argument contains a line break
+ *
  * @example
  *     dimctrl.triggerInterrupt();
@@ -140 +154 @@
  *     dimctrl.triggerInterrupt("arg1=x arg2 arg3");
  *
- * @throws
- *    if an argument contains a line break
  */
 dimctrl.triggerInterrupt = function() { /* [native code] */ }