search

jsdoc2md / jsdoc-parse

parses jsdoc documentation from javascript or html files, outputs JSON
MIT License
95 stars 19 forks source link

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

Closed afsmith92 closed 1 week ago

afsmith92 commented 6 years ago

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:

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 commented 6 years ago

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

75lb commented 6 years ago

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 commented 5 years ago

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

75lb commented 1 week ago

PR Merged and released, let me know if there's anything else. Feel free to also test the jsdocm2d v9 pre-release if you like.