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,5 +1,5 @@
--- @module consent
-- A utility module for checking consent
--- A utility module for checking consent
-- @module consent
local consent = {
name = "Consent process utility",
@ -17,6 +17,9 @@ consent.config = {
votes_required = 1
}
--- Initiate consent
-- @function consent:initiate
-- @param result
function consent:initiate(result)
self.data.result = result
-- if org is empty, consent is given automatically
@ -32,6 +35,9 @@ function consent:initiate(result)
end
end
--- Callback
-- @function consent:callback
-- @param member
function consent:callback(member)
modpol.interactions.binary_poll_user(
member,