Skip to content

comments describing callbacks dropped from generated documentation #13

@xorcus

Description

@xorcus

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions