Closed DigitalBrainJS closed 2 months ago
I'm trying to document a dynamic generated method, so I use name tag for this, but it doesn't generate any namepaths/documentation.
name
class Animal{ /** * Creates a new animal instance */ constructor() { } /** * foo method */ foo(){} /** * @name Animal#bar * @function * @memberof Animal * @description test * @param {number} x * @returns {boolean} */ }
jsdoc2md --namepaths index.js
{ "module": [], "class": [ "Animal" ], "constructor": [ "Animal" ], "mixin": [], "member": [], "namespace": [], "constant": [], "function": [ "Animal#foo" // Animal#bar is missing ], "event": [], "typedef": [], "external": [] }
But my IDE recognizes the method correctly:
Hi, does this work as expected when generating docs directly using jsdoc?
Also, make sure you have a @module defined at the top: read this
@module
I'm trying to document a dynamic generated method, so I use
name
tag for this, but it doesn't generate any namepaths/documentation.jsdoc2md --namepaths index.js
But my IDE recognizes the method correctly: