Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Optional, multi-type parameters not labelled as optional in the docs #11095

Closed
@gkalpak

Description

@gkalpak

Some optional parameters to functions are not labelled as optional in the docs, inspite being documented as such. This seems to be related to the format used for optional, multi-type parameters.
E.g.:

@param {string=} xyz ...   ---> Appears correctly in the docs 
@param {(string|number)=} xyz ...   ---> Appears correctly in the docs 
@param {string|number=} xyz ...   ---> Does NOT appear correctly in the docs 

(E.g. toJson's pretty parameter: docs vs source)

Could this be an issue with dgeni or should all {x|y=} occurences be replaced with {(x|y)=} ?

Metadata

Metadata

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions