Changeset 16804 for trunk

Timestamp:

06/10/13 17:25:04 (11 years ago)

Author:

tbretz

Message:

Updated the description of setInterruptHandler and added triggerInterrupt

File:

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

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

@@ -109 +109 @@
  *
  * @example
- *     function handleIrq(payload, time, user)
+ *     function handleIrq(irq, args, time, user)
  *     {
- *         console.out("Data received:  "+payload);
+ *         console.out("IRQ received:   "+irq);
  *         console.out("Interrupt time: "+time);
  *         console.out("Issuing user:   "+user);
+ *         console.out("Arguments:");
+ *         for (var key in args)
+ *             console.out(" args["+key+"="+args[key]);
  *     }
  *     dimctrl.setInterruptHandler(handleIrq);
  */
 dimctrl.setInterruptHandler = function() { /* [native code] */ }
+
+/**
+ * You can also issue an interrupt from anywhere in your code.
+ *
+ * @param argument
+ *     Any kind of argument can be given. If it is not a String, it
+ *     is converted using the toString() member function. The result
+ *     must not contain any line break.
+ *
+ * @param [. . .]
+ *     Any number of additional arguments. Each argument will appear in
+ *     a new line.
+ *
+ * @example
+ *     dimctrl.triggerInterrupt();
+ *     dimctrl.triggerInterrupt("my_command");
+ *     dimctrl.triggerInterrupt("my_command arg1 arg2=x arg3");
+ *     dimctrl.triggerInterrupt("arg1=x arg2 arg3");
+ *
+ * @throws
+ *    if an argument contains a line break
+ */
+dimctrl.triggerInterrupt = function() { /* [native code] */ }