Added ldoc comments for all lua modules and generated docs in documentation index.html

This commit is contained in:
SkylarHew
2022-01-20 11:04:44 -07:00
parent 5085d87f68
commit da7b996a8b
41 changed files with 4307 additions and 35 deletions

View File

@ -1,4 +1,4 @@
--- leave_org
--- Removes initiator from org
-- @module leave_org
local leave_org = {
@ -13,10 +13,9 @@ leave_org.data = {
leave_org.config = {
}
--- (Required): initiate function
-- Modules have access to the following instance variables:
-- @param result (optional) Callback if this module is embedded in other modules
-- @function initiate
--- Removes user from org
-- @function leave_org:initiate
-- @param result
function leave_org:initiate(result)
if self.org == modpol.instance then
modpol.interactions.message(
@ -35,5 +34,4 @@ function leave_org:initiate(result)
self.org:delete_process(self.id)
end
--- (Required) Add to module table
modpol.modules.leave_org = leave_org