-
Notifications
You must be signed in to change notification settings - Fork 131
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 JSDoc "synonyms" for tags #203
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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}
)It would also be valuable for type parameter support (#72), allowing
@template
as a synonym for@typeParam
.The text was updated successfully, but these errors were encountered: