Ldoc comments for orgs.base and edited comments for template_module
This commit is contained in:
@ -1,11 +1,11 @@
|
||||
--- module_template
|
||||
--- Template for module writers
|
||||
-- @module module_template
|
||||
|
||||
--- (Required): data table containing name and description of the module
|
||||
--- (Required): Data table containing name and description of the module
|
||||
-- @field name "Human-readable name (parens OK, no brackets)"
|
||||
-- @field slug "Same as module class name"
|
||||
-- @field desc "Description of the module"
|
||||
-- @field hide "Whether this is a hidden utility module"
|
||||
-- @field hide Whether this is a hidden utility module
|
||||
local module_template = {
|
||||
name = "Module Human-Readable Name",
|
||||
slug = "module_template",
|
||||
@ -14,12 +14,12 @@ local module_template = {
|
||||
}
|
||||
|
||||
--- (Required) Data for module
|
||||
-- Variables that module uses during the course of a process
|
||||
-- Variables that module uses during the course of a process.
|
||||
-- Can be blank
|
||||
module_template.data = {
|
||||
}
|
||||
|
||||
--- (Required): config for module
|
||||
--- (Required): Config for module
|
||||
-- Defines the input parameters to the module initiate function.
|
||||
-- Can be blank
|
||||
-- When calling a module from within another module,
|
||||
@ -32,7 +32,7 @@ module_template.config = {
|
||||
field_2 = "majority"
|
||||
}
|
||||
|
||||
--- (Required): initiate function
|
||||
--- (Required): Initiate function
|
||||
-- Modules have access to the following instance variables:
|
||||
-- <li><code>self.org</code> (the org the module was called in),</li>
|
||||
-- <li><code>self.initiator</code> (the user that callced the module),</li>
|
||||
|
Reference in New Issue
Block a user