How To Display Javascript Methods In A 'group' In Jsdoc?

Is there are possibility to 'group' functions within a class (AMD/RequireJS Module) ? My classes have sometimes over 20+ functions which actually belong to a specific 'interface im

Solution 1:

this is one way to do it, your module shape may very, but this works with classes and modules:

/**
* @module foobar
*
* @memberof module:foobar
* @param {string} arg an argument
**/
functionone(arg) {
    console.log(arg)
}
module.exports = {
    one: one
}

the key is to use @memberof, documented here.

you can use it with @class documentation, or @module documentation, so it can work with any variety of ES5, ES6, or TypeScript Class or Module shapes, so long as you document the container object (class or module) with @class or @module.

result: