Navigation Menu

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

Support @deprecated, @alpha, and @beta TSDoc modifiers #1381

Closed
alexkreidler opened this issue Oct 26, 2020 · 3 comments
Closed

Support @deprecated, @alpha, and @beta TSDoc modifiers #1381

alexkreidler opened this issue Oct 26, 2020 · 3 comments
Labels
enhancement Improved functionality
Milestone

Comments

@alexkreidler
Copy link

#547 mentions that a goal of future TypeDoc versions is to be compliant with TSDoc.

@deprecated is a core TSDoc standard that is used by many tools, including IDEs like VSCode to indicate deprecation.

Although @alpha and @beta are "discretionary" modifiers, they are used by API Extractor and many Microsoft APIs (e.g. rush, heft, etc), and I believe are quite useful.

I propose we either add a strikethough, "gray out" the name, or add an icon next to items that are marked deprecated.
I also propose we add icons/tags in the UI next to items that are marked @alpha and @beta.

These are likely less important than other core TSDoc features like @linking, etc, so it may likely be implemented later.

Thanks for an awesome tool!

@alexkreidler alexkreidler added the enhancement Improved functionality label Oct 26, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 28, 2020

Definitely planned - but probably won't happen this year... I'm planning on starting on TSDoc support come January though :)

@doberkofler
Copy link

Support for @deprecated would be most appreciated

@Gerrit0 Gerrit0 added this to the TSDoc milestone Feb 20, 2021
@kamranayub
Copy link
Contributor

Here is a commit you could reference where we support @obsolete (before deprecated was a thing), maybe for Hacktoberfest I could add this for @deprecated

excaliburjs/typedoc-default-themes@8c824b8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
No open projects
Development

No branches or pull requests

4 participants