Skip to content
New issue

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

Upgrading to 2.x.x #28

Closed
vvo opened this issue Oct 24, 2016 · 2 comments
Closed

Upgrading to 2.x.x #28

vvo opened this issue Oct 24, 2016 · 2 comments

Comments

@vvo
Copy link

vvo commented Oct 24, 2016

Hey hi, is there a migration guide or some notes on how to upgrade to 2.x.x and what does it brings? Thanks

@75lb
Copy link
Member

75lb commented Oct 24, 2016

i can write one for you tonight but my quickest answer is: use jsdoc2md.getTemplateData().

This method would return you identical data to what jsdoc-parse v1 returns, with the exception of the enum and @private changes i mentioned here

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.

@vvo
Copy link
Author

vvo commented Oct 24, 2016

Thanks! I think that's enough

@vvo vvo closed this as completed Oct 24, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants