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

Upgrade underlying jsdoc #134

Closed
75lb opened this issue Jul 27, 2017 · 6 comments
Closed

Upgrade underlying jsdoc #134

75lb opened this issue Jul 27, 2017 · 6 comments

Comments

@75lb
Copy link
Member

75lb commented Jul 27, 2017

Jsdoc version 3.5.0 was released recently which is able to parse any ES2017 code without the need for Babel plugins. This will mean jsdoc2md users will no longer need to follow the process described here.

I'm testing v3.5.3 with jsdoc2md now, there are a few issues but no blockers. A new jsdoc2md release is imminent.

I'm also considering dropping the --html feature as it gets little use.

@75lb 75lb self-assigned this Jul 27, 2017
@75lb
Copy link
Member Author

75lb commented Aug 9, 2017

I published a pre-release which uses jsdoc@^3.5.3. Generally it works fine but I've found a few differences in output which i'm reviewing. Please try it for yourself and let me know if you find any issues.

$ npm install -g jsdoc-to-markdown@next

@75lb 75lb removed their assignment Nov 4, 2017
@75lb
Copy link
Member Author

75lb commented Nov 14, 2017

Has anyone had time to test jsdoc-to-markdown@next? Does everything working ok?

@victusfate @hydrabolt @weizhongtan @IUnknown68 @wemakeweb @beejjacobs @arronhunt

@beejjacobs
Copy link

I've been using it in my module here without any issues.

@75lb
Copy link
Member Author

75lb commented Jan 18, 2018

Fixed and released in v4.0.0 👍

@75lb 75lb closed this as completed Jan 18, 2018
@Rybadour
Copy link

Rybadour commented Oct 4, 2018

I'm confused, you're still using jsdoc-parse 3.0 doesn't this mean it's still using jsdoc 3.0? I've recently ran into a problem with "export class" not being recognized as an ES6 class. This appears to be fixed in JsDoc 3.5. Thoughts?

@75lb
Copy link
Member Author

75lb commented Oct 4, 2018

jsdoc2md uses jsdoc-api, which uses jsdoc v3.5.. exporting values from ECMAScript modules works fine.. examples here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants