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.

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

Support JSDoc "synonyms" for tags #203

Open
rbuckton opened this issue Dec 19, 2019 · 2 comments · May be fixed by #204
Open

Support JSDoc "synonyms" for tags #203

rbuckton opened this issue Dec 19, 2019 · 2 comments · May be fixed by #204

Comments

@rbuckton
Copy link
Member

JSDoc supports synonyms for many tags, and it would be worthwhile to support those synonyms for code bases that were previously migrated from JavaScript to TypeScript without requiring an investment in time to rewrite doc comment tags to support TSDoc. For example:

  • @abstract (synonyms: @virtual)
  • @augments (synonyms: @extends)
  • @default (synonyms: @defaultvalue)
  • @description (synonyms: @desc)
  • @fires (synonyms: @emits)
  • @param (synonyms: @arg, @argument)
  • @returns (synonyms: @return)
  • @throws (synonyms: @exception)
  • @yields (synonyms: @yield)
  • {@link} (synonyms: {@linkcode}, {@linkplain})
  • etc.

It would also be valuable for type parameter support (#72), allowing @template as a synonym for @typeParam.
@rbuckton rbuckton linked a pull request Dec 19, 2019 that will close this issue
Open
@rbuckton
Copy link
Member Author

I threw together a PR that adds support for synonyms.

@hosseinmd
Copy link

hosseinmd commented Mar 4, 2021 •
edited

@template is supporting by vscode and jsdoc, tsdoc should support it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add support for synonyms rbuckton/tsdoc
2 participants
@rbuckton @hosseinmd