Template:Nasal method documentation

From FlightGear wiki
Jump to navigation Jump to search


No description.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

The name of the function / method (without parentheses)

Example
cmdarg
Auto value
Stringrequired
Descriptiondescription

A description of the function / method being documented.

Auto value
Stringrequired
Return typereturn-type

Type of the returned value (if any)

Default
nil
Auto value
nil
Stringrequired
Return valuereturn-value

The value returned by the function / method.

Default
nil
Example
Boolean value of the property node.
Auto value
nil
Stringrequired
Positional argumentpositional-argument

A mandatory argument

Auto value
Templatesuggested
Keyword argumentkeyword-argument

An argument with a default value

Templatesuggested