Add support for the `@property` tag
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
I was trying to JSDoc/TSDoc a TypeScript interface, and wanted to use the property tag to document the various properties. However, property does not appear to be on the list of supported TSDoc tags.
Probably related: https://github.com/microsoft/tsdoc/issues/209
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 supported tag list in tsdoc/src/details/StandardTags.ts and the related discussion in issue 209. Determine how @property should be supported for documenting TypeScript interface properties; done means the tag is recognized and its expected behavior is covered by the project's 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
- 45/100