Releases: jsdoc2md/jsdoc-parse
Releases · jsdoc2md/jsdoc-parse
v6.2.0
v2.0.5
Breaking since 1.2.7
- Streaming interface removed. Jsdoc-parse now exports a single, synchronous function which expects you to supply raw jsdoc data (which you can get from jsdoc-api).
- CLI removed. Use
jsdoc2md --json
.
Data and rendered output changes
- enum is now interpreted as a kind (like
member
,class
etc.) not a doclet property, as before. TheisEnum
property in the output has gone. @private
and@ignored
doclets and are now left in the output and filtered out at template (dmd) level instead.
Migrating from v1 to v2
The best solution is to use jsdoc2md.getTemplateData().
This method returns identical data to what jsdoc-parse v1 returned (with the exception of the enum
and @private
changes mentioned above)
jsdoc2md.getTemplateDataSync({ files: 'lib/*.js' })
// returns jsdoc-parse data
you could use jsdoc-parse v2 alone if you like but it expects raw jsdoc data to be passed in - which you could get using jsdoc-api.