Difference between revisions of "Template:FunctionArgument"
Jump to navigation
Jump to search
imported>SnakeChomp (Move template code to the top. Add Value to example 4.) |
imported>Cipscis (→Example 4: Added default value) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 8: | Line 8: | ||
|Type = The type of the function argument (int, float, ref, string, ...) | |Type = The type of the function argument (int, float, ref, string, ...) | ||
|Optional = If specified, the argument is optional | |Optional = If specified, the argument is optional | ||
| | |Value = If specified, appears after the name and type information. | ||
}} | }} | ||
</pre> | </pre> | ||
| Line 26: | Line 26: | ||
<pre>{{FunctionArgument | <pre>{{FunctionArgument | ||
| | |Value = 0, 1 | ||
}}</pre> | }}</pre> | ||
| Line 37: | Line 37: | ||
<pre>{{FunctionArgument | <pre>{{FunctionArgument | ||
|Name = flag | |Name = flag | ||
| | |Value = 0, 1 | ||
}}</pre> | }}</pre> | ||
| Line 50: | Line 50: | ||
|Name = foo | |Name = foo | ||
|Type = int | |Type = int | ||
|Value = 0,1 | |Value = 0, 1; Default = 0 | ||
|Optional = y | |Optional = y | ||
}}</pre> | }}</pre> | ||
| Line 57: | Line 57: | ||
|Name = foo | |Name = foo | ||
|Type = int | |Type = int | ||
|Value = 0,1 | |Value = 0, 1; Default = 0 | ||
|Optional = y | |Optional = y | ||
}} | }} | ||
</noinclude> | </noinclude> | ||
Latest revision as of 01:10, 15 May 2009
Template syntax[edit source]
{{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[edit source]
{{FunctionArgument
|Name = foo
|Type = int
}}
foo:int
Example 2[edit source]
{{FunctionArgument
|Value = 0, 1
}}
{0, 1}
Example 3[edit source]
{{FunctionArgument
|Name = flag
|Value = 0, 1
}}
flag{0, 1}
Example 4[edit source]
{{FunctionArgument
|Name = foo
|Type = int
|Value = 0, 1; Default = 0
|Optional = y
}}
foo:int{0, 1; Default = 0}