Difference between revisions of "Template:Function"

From Vendetta Lua
Jump to: navigation, search
Line 16: Line 16:
 
</pre>
 
</pre>
 
</noinclude>
 
</noinclude>
 +
 +
{{Function_wrapped
 +
| name        = {{{name}}}
 +
| desc        = {{{desc}}}
 +
| arg1_name    = {{{arg1_name}}}
 +
| arg1_type    = {{{arg1_type}}}
 +
| arg1_desc    = {{{arg1_desc}}}
 +
| ret1_name    = {{{ret1_name}}}
 +
| ret1_type    = {{{ret1_type}}}
 +
| ret1_desc    = {{{ret1_desc}}}
 +
| notes        = {{{notes}}}
 +
}}

Revision as of 08:26, 30 March 2011

The following is currently just the intended syntax. No template code exists.
This function will in turn call Template:Function_wrapped

{{Function
| name         = Function Name
| desc         = Function description
| arg1_name    = argument (1,2,...,n) name
| arg1_type    = [nil, boolean, number, string, function, userdata, thread, table]
| arg1_desc    = argument (1,2,...,n) description, including examples if so desired
| ret1_name    = return value (1,2,...,n) name
| ret1_type    = [nil, boolean, number, string, function, userdata, thread, table]
| ret1_desc    = return value (1,2,...,n) description, including examples if so desired
| notes        = notes
}}


{{{name}}}

Definition

{{{name}}}( {{{arg_list}}}) ->  {{{ret_list}}}
Description

{{{desc}}}
Arguments

Type Name Description
{{{arg_list}}}
Returns

Type Name Description
{{{ret_list}}}
Notes

{{{notes}}}