Template:Function/doc

This template displays a function's description of the LUA support.

Usage
This template is used by entering:

Parameters

 * name
 * The function's name.


 * syntax
 * The syntax for using the function.


 * desc
 * A brief description of the function.


 * args (optional)
 * The arguments of the function.
 * Display it only if the function in question has arguments.
 * Use the FunctionArg template to complete this parameter.


 * rets (optional)
 * What the function returns.
 * Display it only if the function in question returns information.
 * Use the FunctionRet template to complete this parameter.


 * examples (optional)
 * Examples of use of the function.
 * Always try to give at least one example to simplify the user's understanding.
 * Use the FunctionExample template to complete this parameter.