jsdoc3Template icon indicating copy to clipboard operation
jsdoc3Template copied to clipboard

comments describing callbacks dropped from generated documentation

Open xorcus opened this issue 11 years ago • 0 comments

With the following jsdoc comment, it is expected that a type definition appears on the page where MyClass is documented, and to be able to reference the callback type when documenting method arguments like this: @param {MyClass~myCallbackType} callback The callback invoked when ...

/**

  • Description of my callback function type
  • @callback MyClass~myCallbackType
  • @param {string} arg1 The first argument
  • @param {object} arg2 The second argument */

using "@typedef {function} MyClass~myCallbackType" does not work either

xorcus avatar Dec 16 '13 09:12 xorcus