-
Notifications
You must be signed in to change notification settings - Fork 142
Open
Labels
octogonz-parser-backlogItems for @octogonz to consider during the next iteration on the parserItems for @octogonz to consider during the next iteration on the parserrequest for commentsA proposed addition to the TSDoc specA proposed addition to the TSDoc spec
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.
aciccarello, flyyang, seanpoulter, ozyman42, rbuckton and 68 more
Metadata
Metadata
Assignees
Labels
octogonz-parser-backlogItems for @octogonz to consider during the next iteration on the parserItems for @octogonz to consider during the next iteration on the parserrequest for commentsA proposed addition to the TSDoc specA proposed addition to the TSDoc spec