1

How can I properly document a returned callback that returns multiple parameters. Exe:

return callback(error, success);

JDillon522
  • 19,046
  • 15
  • 47
  • 81

1 Answers1

0

I would document this return value as follows:

/**
 * @return {Function} Returns the callback in the form of `callback(error, success)`
 */

That is -- use the actual string description of the return statement. (YUIDoc doesn't really have the ability to document what you want explicitly, without describing in text.)

Dmitri Zagidulin
  • 1,117
  • 9
  • 23