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

Constructor documentation is ignored unless description or @param is included #33

Open
afsmith92 opened this issue Dec 17, 2017 · 3 comments

Comments

@afsmith92
Copy link

I ran into this issue where @example tags on class docs get ignored if a description (tagless description or @description -- not @classdesc) is not included.

Based on this line the following tags on class docs are associated to the constructor:

  • description
  • params
  • examples
  • returns
  • exceptions

However, on this line a constructor is only output if it has a description or params. Would it make sense to update this to check for examples, returns, and exceptions as well?

@afsmith92
Copy link
Author

@75lb Any thoughts on this? I'd be happy to submit a PR.

@75lb
Copy link
Member

75lb commented Jan 6, 2018

sorry, I haven't had chance to properly triage it yet.. It's possible the issue stems from the underlying jsdoc, which has seen some project activity recently - i need to catch up and start using the latest version. Feel free to submit a PR if you find a quick fix.

@75lb
Copy link
Member

75lb commented May 12, 2019

Could you check whether this issue is resolved by jsdoc2md v5.0.0 please?

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