jsdoc-parse icon indicating copy to clipboard operation
jsdoc-parse copied to clipboard

Constructor documentation is ignored unless description or @param is included

Open afsmith92 opened this issue 8 years ago • 3 comments

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 avatar Dec 17 '17 21:12 afsmith92

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

afsmith92 avatar Jan 03 '18 17:01 afsmith92

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 avatar Jan 06 '18 12:01 75lb

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

75lb avatar May 12 '19 18:05 75lb

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.

75lb avatar Sep 01 '24 13:09 75lb