Skip to content

Nicer formatting for the doc of optional method arguments #16

@AdrianVasiliu

Description

@AdrianVasiliu

(minor)
The current output for optional method parameters (say, @param {String|Int} [position] This param does this and that.) looks as follows:

image

It might be nicer to get a more compact output, without adding the “Argument” column, say:

image

Remark: as a matter of fact, such an output can be already obtained using

@param {String|Int} position <i>Optional</i><br/>If reference is a...

that is without using the special JSDoc syntax for optional arguments. But I think this wouldn't be a good solution.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions