reactjs / reactjs/react-docgen
[Feature Request] Support document tags
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
Can react-docgen parse document tags as metadata instead of description? Like @since, @see, @deprecated
/**
* My Component
* @since 1.2.0
*/
export function MyComponent() {}
Contributor guide
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
The issue names no file or test path; start by reviewing react-docgen's existing comment parsing and metadata output. Use the @since, @see, and @deprecated example as the acceptance case: these tags should be represented as metadata rather than included in the description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100