Template:Helper module/doc: Difference between revisions

From Discord Dungeons Wiki
Jump to navigation Jump to search
(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 RuneScape:Lua/Helper modules to help produce a dynamic table. <pre> {{Helper module |n...")
 
No edit summary
 
Line 3: Line 3:
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.
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 [[RuneScape:Lua/Helper modules]] to help produce a dynamic table.
This template is called by [[DD_Wiki:Lua/Helper modules]] to help produce a dynamic table.


<pre>
<pre>

Latest revision as of 13:55, 31 March 2022

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.
{{#replace:Template:Helper module/doc|/doc}} 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 DD_Wiki: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
}}