Skip to content
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.

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

@deprecated tag #1531

Closed
thernstig opened this issue Mar 10, 2021 · 3 comments
Closed

@deprecated tag #1531

thernstig opened this issue Mar 10, 2021 · 3 comments
Labels
enhancement Improved functionality
Milestone

Comments

@thernstig
Copy link

Search Terms

@deprecated, jsdoc, typedoc, vs code, vscode

Problem

I am contemplating moving from JSDoc to TypeDoc, but could not find if you support a @deprecated tag. It would be a nice additon. E.g. VS Code can infer a lot form this tag and cross-over text for deprecated methods etc.

Suggested Solution

Support the @deprecated tag.

@thernstig thernstig added the enhancement Improved functionality label Mar 10, 2021
@thernstig thernstig changed the title @deprecated keyword @deprecated tag Mar 10, 2021
@Gerrit0 Gerrit0 added this to the TSDoc milestone Mar 10, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 10, 2021

TypeDoc will render any tag you use - so unless there's extra behavior needed to make a tag useful, we technically support it.

I think it would make sense to add some special logic for this one so that it stands out more.

@cAttte
Copy link
Contributor

cAttte commented Apr 11, 2021

isn't this a duplicate of #1381?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 11, 2021

So it is, thanks!

@Gerrit0 Gerrit0 closed this as completed Apr 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

3 participants