Template:FunctionArgument

From GECK
Jump to: navigation, search


Template syntax

{{FunctionArgument
|Name = The name of the function argument. May be omitted, but it only makes sense
        to do so when ''Values'' is specified.
|Type = The type of the function argument (int, float, ref, string, ...)
|Optional = If specified, the argument is optional
|Value = If specified, appears after the name and type information.
}}

Example 1

{{FunctionArgument
|Name = foo
|Type = int
}}

 foo:int

Example 2

{{FunctionArgument
|Value = 0, 1
}}

 {0, 1}

Example 3

{{FunctionArgument
|Name = flag
|Value = 0, 1
}}

 flag{0, 1}

Example 4

{{FunctionArgument
|Name = foo
|Type = int
|Value = 0, 1; Default = 0
|Optional = y
}}

 foo:int{0, 1; Default = 0}