Template:APIDoc
Jump to navigation
Jump to search
Template documentation
This documentation is transcluded from Template:APIDoc/doc. [edit] [history] [purge]
Template:APIDoc invokes function main in Module:APIDoc using Lua.
The APIDoc template generates a table to describe a module's public function.
{{APIDoc |funcName = |funcDesc = |arg1 = |type1 = |desc1 = |returnType = |returnDesc = }}
Usage
No arguments, no return value
someFunction() | |||
This function does something. | |||
Returns | -- |
No arguments, return value
someFunction() | |||
This function does something. | |||
Type | Description | ||
Returns | table | A table of data. |
One argument, no return value
someFunction(a) | |||
This function does something. | |||
Argument | Type | Description | Optional |
a | number | A number of some kind. | |
Returns | -- |
Multiple arguments, return value
someFunction(a, b) | |||
This function does something. | |||
Argument | Type | Description | Optional |
a | number | A number of some kind. | |
b | string | A string of some kind. | |
Returns | table | A table of data. |