Difference between revisions of "User:Demonnic"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
− | + | =Proposed template for lua functions | |
− | for | ||
− | |||
− | |||
− | |||
+ | |||
+ | ==functionName== | ||
+ | ;functionName(arg1, arg1) | ||
+ | : What the function does. | ||
+ | : See also: [[Manual:Lua_Functions#paste|paste]] | ||
+ | <br/> | ||
+ | |||
+ | ;Parameters | ||
+ | * arg1: | ||
+ | : What arg1 is/does. Passed as a string. | ||
+ | * arg2: | ||
+ | : What arg2 is/does. Passed as a string. | ||
+ | <br/> | ||
+ | |||
+ | ;Usage | ||
<lua> | <lua> | ||
− | + | --a small example snippet of the function in action | |
− | + | --the comments up top should introduce it/explain what the snippet does | |
− | + | functionName("arg1", "arg2") | |
</lua> | </lua> |
Revision as of 07:47, 12 June 2011
=Proposed template for lua functions
functionName
- functionName(arg1, arg1)
- What the function does.
- See also: paste
- Parameters
- arg1:
- What arg1 is/does. Passed as a string.
- arg2:
- What arg2 is/does. Passed as a string.
- Usage
<lua> --a small example snippet of the function in action --the comments up top should introduce it/explain what the snippet does functionName("arg1", "arg2") </lua>