NAME-EXPRESSION
documentjs.nameExpression
{STRING}
Adds the name
and other properties to valueData in
using the @param or
@option tags.
[name(args...)=default]
Example:
[success(item)=updater]
Parameters
-
name
{String}
Provides the name of the type.
-
[]
{String}
Indicates that the option or param is optional.
-
(args...)
{String}
If
name
is a function,()
provides the names of each argument. -
'...'
{String}
An argument is variable. The argument can be given 0 or more times.
-
=default
{String}
=default
provides the default value for the type. For example:/** * @param {Number} [age=0] */
Examples
eventType
The param is named "eventType".[eventType]
The param is optional.[eventType="change"]
The param is optional and has a default value of "change".handler(foo,bar)
The param is named "handler" and takes a foo and bar argument.