Skip to content

RFC: Support for dot syntax on @param #19

Open
@darrenmart

Description

@darrenmart

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    octogonz-parser-backlogItems for @octogonz to consider during the next iteration on the parserrequest for commentsA proposed addition to the TSDoc spec

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions