Support @deprecated jsdoc tag #12759
Open
Comments
|
Hi, Can i dig into this? |
|
@kraken-coder yes please! assigned |
|
Very good solution already. Your topic is very good. thank you very much! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe💯
In my component's props TS interface, I can use JSDoc comments to set the description, and can even use the
@defaulttag to describe the default valueHowever, nothing happens when I use the
@deprecatedtag.Describe the solution you'd like
Some ideas:
<tr>gotrequiredanddeprecatedclassesNames e.g.<tr className="required">&<tr className="deprecated">so that I can easily apply custom styling to these rows.Describe alternatives you've considered
For now I will simply omit deprecated props manually per story via the meta default export's parameters.
parameters.docs.page.excludeProps = ['my_depricated_prop_name']Are you able to assist to bring the feature to reality?
Perhaps in the future but not at this time.
Additional context
https://jsdoc.app/tags-deprecated.html
The text was updated successfully, but these errors were encountered: