Added LDoc comments for new files, ready to merge pt. 2

This commit is contained in:
SkylarHew
2022-01-23 18:21:23 -07:00
parent e72911c67c
commit 79b548f9a0
24 changed files with 118 additions and 94 deletions

View File

@ -1,5 +1,5 @@
--- Remove child (consent)
-- A simple module that calls a consent process on an org to remove its child
--- Remove child (consent).
-- A simple module that calls a consent process on an org to remove its child.
-- Depends on the Consent module.
-- @module remove_child_consent
@ -19,7 +19,7 @@ remove_child_consent.config = {
--- Removes a child org with consent
-- @function remove_child_consent:initiate
-- @param result
-- @param result Callback if this module is embedded in other modules
function remove_child_consent:initiate(result)
local children = {}
for i,v in ipairs(self.org.children) do
@ -58,6 +58,8 @@ function remove_child_consent:initiate(result)
end
end
--- Complete the remove process
-- @function remove_child_consent:complete
function remove_child_consent:complete()
modpol.interactions.message_org(
self.initiator, self.data.child_to_remove.id,