User:Draugath

From Vendetta Lua
Revision as of 02:44, 31 March 2011 by Draugath (talk | contribs)
Jump to navigationJump to search

I'm going to be working on a series of Templates for easing the creation of function entries and producing identical results across all function entries.

Template:Function

This template will be the top-level wrapper template that handles input and passing of information.
Template:Function

Template:Function_wrapped

This template will initially be the one that provides the final output. More templates may be created later.
Template:Function_wrapped

Example

{{Function
| name         = FunctionName
| desc         = Function description
| arg1_name    = arg1
| arg1_type    = number
| arg1_desc    = argument (1,2,...,n) description, including examples if so desired
| arg2_name    = arg2
| arg2_type    = string
| arg2_desc    = argument (1,2,...,n) description, including examples if so desired
| ret1_name    = ret1
| ret1_type    = string
| ret1_desc    = return value (1,2,...,n) description, including examples if so desired
| ret2_name    = ret2
| ret2_type    = table
| ret2_desc    = return value (1,2,...,n) description, including examples if so desired
| notes        = notes
}}

FunctionName

Definition
FunctionName( number  arg1,  string  arg2) ->  string  ret1,  table  ret2
Description
Function description
Arguments
Type Name Description
number arg1 argument (1,2,...,n) description, including examples if so desired
string arg2 argument (1,2,...,n) description, including examples if so desired
Returns
Type Name Description
string ret1 return value (1,2,...,n) description, including examples if so desired
table ret2 return value (1,2,...,n) description, including examples if so desired
Notes
notes