RFC: Support for dot syntax on @param
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
I'm currently working with d.ts files where methods taking object parameters are documented with the following approach:
/**
* Method description.
* @param options addItemOptions - e.g. { id: 1234, title: "someTitle" }
* id: The unique identifier.
* title: The title to assign.
**/
It's challenging to parse and auto-generate documentation for these parameters given this approach. Ideally there'd be support for dot syntax e.g.:
@param options.id - The unique identifier.
@param options.title - The title to assign.
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 with the proposed @param options.id and options.title syntax and review the 25-comment discussion. The issue names no implementation files or tests, so first locate the relevant TSDoc specification and parser entry points. Done means defining and implementing the syntax consistently, with coverage for nested parameter documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100