Support JSDoc "synonyms" for tags
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the listed JSDoc/TSDoc tag pairs and the type-parameter request in #72. Done means the supported synonyms, including inline link forms, are accepted without requiring comment rewrites; the issue does not name files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100