Template:Helper module/doc

From Brighter Shores Wiki
Revision as of 17:53, 22 March 2024 by Habblet (talk | contribs) (Created page with "{{Documentation}} {{Invokes|Helper module}} Provides documentation for functions of modules that contain functions useful for other modules. This template should be part of a comment, and should be at the top of the source code, '''before''' any <nowiki><pre> or <nowiki></nowiki> tags. There is no limit to the number of functions this template can list. This template is called by Brighter Shores:Lua/Helper modules to help produce a dynamic table. <pre> {{Helper mod...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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.
Template:Helper module invokes Module:Helper module using Lua.

Provides documentation for functions of modules that contain functions useful for other modules. This template should be part of a comment, and should be at the top of the source code, before any <pre> or <nowiki> tags. There is no limit to the number of functions this template can list.

This template is called by Brighter Shores: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
|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
}}