Difference between revisions of "Template:FunctionArgument"
Jump to navigation
Jump to search
imported>SnakeChomp m (Fix eamples to use new template name) |
imported>SnakeChomp (Display type and values at the same time if both are specified) |
||
| Line 6: | Line 6: | ||
|Name = The name of the function argument. May be omitted, but it only makes sense | |Name = The name of the function argument. May be omitted, but it only makes sense | ||
to do so when ''Values'' is specified. | to do so when ''Values'' is specified. | ||
|Type = The type of the function argument (int, float, ref) | |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 | ||
|Values = If specified, the | |Values = If specified, appears after the name and type information. | ||
}} | }} | ||
</pre> | </pre> | ||
| Line 59: | Line 59: | ||
}} | }} | ||
</noinclude><includeonly> {{#if: {{{Optional|}}} | '' |}}{{#if: {{{Name|}}} | {{{Name}}} |}}{{#if: {{{ | </noinclude><includeonly> {{#if: {{{Optional|}}} | '' |}}{{#if: {{{Name|}}} | {{{Name}}} |}}{{#if: {{{Type|}}}|<nowiki>:</nowiki>{{{Type}}}|}}{{#if: {{{Value|}}} | <nowiki>{</nowiki>{{{Value}}}<nowiki>}</nowiki>}}{{#if: {{{Optional|}}} | '' |}}</includeonly> | ||
Revision as of 20:13, 30 January 2009
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
|Optional = y
}}
foo:int