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,6 +1,6 @@
--- Set privilege to org members
-- @module priv_to_org
-- Allows initiator to grant a priv they have to all members of an org
-- @module priv_to_org
local priv_to_org = {
name = "Set privilege to org members",
@ -14,9 +14,9 @@ priv_to_org.data = {
priv_to_org.config = {
}
--- (Required): initiate function
-- @param result (optional) Callback if this module is embedded in other modules
-- @function initiate
--- Initiate function
-- @function priv_to_org:initiate
-- @param result
function priv_to_org:initiate(result)
local player_privs = minetest.get_player_privs(self.initiator)
-- construct table for display
@ -45,5 +45,4 @@ function priv_to_org:initiate(result)
if result then result() end
end
--- (Required) Add to module table
modpol.modules.priv_to_org = priv_to_org