search

softlayer / ember-cli-jsdoc

An Ember CLI addon to generate HTML documentation from JSDoc comments in the source code.
MIT License
21 stars 18 forks source link

Unable to parse async functions #40

Closed erikmellum closed 6 years ago

erikmellum commented 6 years ago

Throws ERROR: Unable to parse on async functions. I'll take a look and see if it's something I can take care of.

Frozenfire92 commented 6 years ago

+1

jdk0517 commented 6 years ago

I'm having the same issue with ember-cli@2.18.0 and ember-cli-jsdoc@1.6.0

notmessenger commented 6 years ago

I have not yet looked into this yet but unfortunately it does not surprise me. Just like @whatever are not able to be parsed I suspect this is the same thing. Perhaps we will be able to find a work around but I know when I tried to support annotations it was a non-starter.

jdk0517 commented 6 years ago

@erikmellum @notmessenger it looks like bumping the jsdoc version to 3.5.0+ fixes this, as that is when it started supporting async: http://usejsdoc.org/tags-async.html. The current release of ember-cli-jsdoc uses jsdoc@3.4.3.

As a workaround for now, after installing ember-cli-jsdoc in my project as a dependency I am also installing jsdoc@3.5.5 - this seems to resolve the issue, and I can compile documentation from code which includes async functions using the ember ember-cli-jsdoc command.

When I have a sec I'll confirm that updating the dependency in ember-cli-jsdoc directly will have the same effect, and throw out a quick PR if so.

notmessenger commented 6 years ago

I am closing this issue as PR #42 resolved this issue and was released as v2.0.0

I closed your PR @jdk0517 in favor of #42 because it was not a completely accurate change-set for how this package is released. Thank you very much though for your research into this and the PR - I only made tweaks :-)