methodparam
methodparam — Parameters to a method.
Synopsis
- Sequence of:
- Zero or more of:
type?- One of:
- Sequence of:
- Zero or more of:
parameterinitializer?
funcparams
- Sequence of:
- Zero or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- choice (enumeration) [default=“req”]
- “opt”
- “plain”
- “req”
- rep (enumeration) [default=“norepeat”]
- “norepeat”
- “repeat”
Description
In the syntax summary of a constructorsynopsis,
destructorsynopsis, or
methodsynopsis, methodparam
provides the description of a parameter to the method. Typically, this
includes the data type of the parameter and its name, but may also
include an initial value and other modifiers.
Processing expectations
Formatted inline. For a complete description of the processing
expectations, see classsynopsis.
Attributes
Common attributes and common linking attributes.
- choice
Indicates optionality.
Enumerated values: “opt” Formatted to indicate that it is optional.
“plain” Formatted without indication.
“req” Formatted to indicate that it is required.
- rep
Indicates whether or not repetition is possible.
Enumerated values: “norepeat” Can not be repeated.
“repeat” Can be repeated.
Parents
These elements contain methodparam: constructorsynopsis, destructorsynopsis, methodsynopsis.
Children
The following elements occur in methodparam: funcparams, initializer, modifier, parameter, type.