Skip to content

do not use @deprecated tag if enum item is deprecated #1052

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

do not use @deprecated tag if enum item is deprecated #1052

wants to merge 2 commits into from

Conversation

@panchenko
Copy link
Contributor

@panchenko panchenko commented Feb 3, 2024 •
edited
Loading

Currently if some enum item a deprecated, then tsdoc is generated mentioning each item, and the deprecated ones are marked with @deprecated.

Values:
- `First`
- `Second` - @deprecated
- `Third`

And then Intellij IDEA treats the whole enum as deprecated. I suggest omitting @ from the generated comment:

Values:
- `First`
- `Second` - deprecated
- `Third`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@jsuryakt jsuryakt jsuryakt approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@panchenko @jsuryakt