Template:Helper module/doc

From RuneScape Classic Wiki
Jump to: navigation, search
Information icon-grey.svg
This is a documentation subpage for Template:Helper module.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Helper module invokes function main in Module:Helper module using Lua.

Provides documentation for functions of modules that contain functions useful for other modules. This template should be part of the modules documentation. There is no limit to the number of functions this template can list.

This template is called by RuneScape:Lua/Helper modules to help produce a dynamic table.

{{Helper module
|name = Name of the module (no namespace prefix)
|fname1 = Name of first function as it is called in modules. If the function has multiple versions they can be split up using <code>;;</code> as a separator.
|ftype1 = Argument types of parameters
|fuse1 = Purpose of the function
...
|fname# = Name of tenth function as it is called in modules
|ftype# = Argument types of parameters
|fuse# = Purpose of the function
|example = <syntaxhighlight lang='lua'>
-- Code
</syntaxhighlight>
}}