Template:FunctionArgument

Revision as of 17:11, 30 January 2009 by imported>SnakeChomp (Fix eamples to use new template name)


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)
|Optional = If specified, the argument is optional
|Values = If specified, the given set of values is shown instead of the type
}}

Example 1

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

 foo:int

Example 2

{{FunctionArgument
|Values = 0, 1
}}

 {0, 1}

Example 3

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

 flag{0, 1}

Example 4

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

 foo:int