jsdoc-to-markdown
jsdoc-to-markdown copied to clipboard
How to describe interface with properties?
If I have an interface
interface Dog {
name: string
age: number
}
How to document it with JSDoc so this lib can parse it?
My failed attempt was
/**
* An animal, human friend
* @interface Dog
* @property {string} name
* @property {number} age
* @memberof module:modulename
*/
interface Dog {
name: string
age: number
}
Does your failed attempt above work in jsdoc? If not, please ensure your docs generate correctly in jsdoc first (jsdoc2md works downstream of jsdoc)..
I think @75lb the question has more to do with "How do I get an interface documentation in the resulting output" rather than something is not working.
In my situation, it all works fine but somehow interface is not where to be found in the output, and there's no error message either. Perhaps you have an example somewhere you could share? Or there's a specific setting that needs to be turned on?
Thank you