We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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:
The text was updated successfully, but these errors were encountered:
Hi, does this work as expected when generating docs directly using jsdoc?
Sorry, something went wrong.
Also, make sure you have a @module defined at the top: read this
@module
No branches or pull requests
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:
The text was updated successfully, but these errors were encountered: