Changeset 16804 for trunk


Ignore:
Timestamp:
06/10/13 17:25:04 (11 years ago)
Author:
tbretz
Message:
Updated the description of setInterruptHandler and added triggerInterrupt
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/FACT++/scripts/doc/dimctrl.js

    r15455 r16804  
    109109 *
    110110 * @example
    111  *     function handleIrq(payload, time, user)
     111 *     function handleIrq(irq, args, time, user)
    112112 *     {
    113  *         console.out("Data received:  "+payload);
     113 *         console.out("IRQ received:   "+irq);
    114114 *         console.out("Interrupt time: "+time);
    115115 *         console.out("Issuing user:   "+user);
     116 *         console.out("Arguments:");
     117 *         for (var key in args)
     118 *             console.out(" args["+key+"="+args[key]);
    116119 *     }
    117120 *     dimctrl.setInterruptHandler(handleIrq);
    118121 */
    119122dimctrl.setInterruptHandler = function() { /* [native code] */ }
     123
     124/**
     125 * You can also issue an interrupt from anywhere in your code.
     126 *
     127 * @param argument
     128 *     Any kind of argument can be given. If it is not a String, it
     129 *     is converted using the toString() member function. The result
     130 *     must not contain any line break.
     131 *
     132 * @param [. . .]
     133 *     Any number of additional arguments. Each argument will appear in
     134 *     a new line.
     135 *
     136 * @example
     137 *     dimctrl.triggerInterrupt();
     138 *     dimctrl.triggerInterrupt("my_command");
     139 *     dimctrl.triggerInterrupt("my_command arg1 arg2=x arg3");
     140 *     dimctrl.triggerInterrupt("arg1=x arg2 arg3");
     141 *
     142 * @throws
     143 *    if an argument contains a line break
     144 */
     145dimctrl.triggerInterrupt = function() { /* [native code] */ }
Note: See TracChangeset for help on using the changeset viewer.