You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
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.
afsmith92
added a commit
to afsmith92/jsdoc-parse
that referenced
this issue
Jan 6, 2018
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?
The text was updated successfully, but these errors were encountered: