descs

Author: coderheck

src/Features/Cleanup/Janitor.lua

@@ -2,6 +2,8 @@
 -- This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
 -- If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
+--- @class Janitor
+
 local RunService = game:GetService("RunService")
 
 local Janitor = {}
@@ -31,6 +33,7 @@ function Janitor.isJanitor(value: table?)
 	return type(value) == "table" and value.ClassName == "Janitor"
 end
 
+--- This function is used to create a new Janitor instance and assign to it an object.
 function Janitor:Give(task: any)
 	local function handleTask(subtask: any)
 		assert(typeof(task) ~= "boolean", "Task cannot be a boolean")
@@ -55,6 +58,7 @@ function Janitor:Give(task: any)
 	return handleTask(task)
 end
 
+--- This function is used to cleanup an object assigned to a currently running Janitor instance.
 function Janitor:Cleanup(taskTable: table?)
 	local tasks = taskTable or self._tasks
 
@@ -87,6 +91,7 @@ function Janitor:Cleanup(taskTable: table?)
 	end
 end
 
+--- This function is used to destroy (basically delete) any Janitor instances currently running.
 function Janitor:Destroy()
 	self:Cleanup()