Template:FunctionArgument

Revision as of 19:15, 30 January 2009 by imported>SnakeChomp (Move template code to the top. Add Value to example 4.)


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
|Values = If specified, appears after the name and type information.
}}

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
|Value = 0,1
|Optional = y
}}

 foo:int{0,1}