so far

Author: Ethan76167

moonwave.toml

@@ -12,7 +12,14 @@ includeReadme = true
 favicon = "https://coderheck.github.io/assets/TRIAosLogoGradient.png"
 
 [[classOrder]]
-classes = ["MapLib", "Skills", "PlayerUI", "Settings"]
+section = "MapLib"
+collapsed = false
+classes = ["MapLib"]
+
+[[classOrder]]
+section = "Features"
+collapsed = true
+classes = ["Skills", "PlayerUI", "Settings", "Players", "Cleanup"]
 
 [[navbar.items]]
 href = "https://discord.gg/tria"

src/Features/Cleanup/Janitor.lua

@@ -13,6 +13,27 @@ local function getJanitors()
 	return require(script.Parent).Janitors
 end
 
+--[=[
+    @class Janitor
+    Another class.
+]=]
+
+--[=[
+	@within Cleanup
+	@since 0.11
+	@function Janitor.new
+	@param name string?
+	@return _tasks: {[string]: any}
+	@return context: string
+	@return name: string?
+	@return index: number | string
+	@return .isJanitor (value: Janitor?) -> boolean
+	@return :Give<T>(task: <T>) -> (<T>) -> <T> 
+	@return :Cleanup (taskTable: any) -> {}
+	@return :Destroy () -> nil
+]=]
+
+
 function Janitor.new(janitorName: string?)
 	local self = setmetatable({}, Janitor)
 	self._tasks = {}

src/Features/Cleanup/init.lua

@@ -14,12 +14,26 @@ if RunService:IsServer() then
 	Round = require(ServerScriptService.server.Services.RoundService.Round)
 end
 
+--[=[
+	@class Cleanup
+	This is the MapLib Feature. It can be accessed by `MapLib:GetFeature("Cleanup")`.
+
+	Description of what this holds
+]=]
+
 --< Main >--
 local Cleanup = {}
+
 Cleanup.Janitors = {}
 
+
 Cleanup.Janitor = require(script.Janitor)
 
+--[=[
+	@since 0.2.4
+	@return Janitor
+	This method returns a Janitor class.
+]=]
 function Cleanup:GetJanitor(janitorName: string?)
 	if self.Janitors[janitorName] then
 		return self.Janitors[janitorName]
@@ -28,6 +42,11 @@ function Cleanup:GetJanitor(janitorName: string?)
 	end
 end
 
+--[=[
+	@since 0.2.4
+	This method returns all the active Janitor classes.
+	@return {Janitor}
+]=]
 function Cleanup:GetJanitors()
 	return self.Janitors
 end

src/Features/PlayerUI.lua

@@ -13,13 +13,9 @@ local PlayerUI = { context = "client" }
 PlayerUI.__index = PlayerUI
 
 --- @class PlayerUI
---- This is the documentation of PlayerUI-related methods.
+--- This is the MapLib Feature. It can be accessed by `MapLib:GetFeature("PlayerUI")`.
 --- @client
 
---- @prop cleanup {ScreenGUI}
---- @readonly
---- @private
---- @within PlayerUI
 function PlayerUI.new()
 	local self = setmetatable({}, PlayerUI)
 
@@ -37,13 +33,12 @@ function PlayerUI.new()
 	return self
 end
 
---- This function is used to load a `ScreenGui` instance.
-function PlayerUI:LoadUI(gui: ScreenGui): ScreenGui
+--- This function is used to load a `ScreenGui` from the map into the players PlayerGUI.
+function PlayerUI:LoadUI(gui: ScreenGui)
 	assert(gui:IsA("ScreenGui"), "':LoadUI' must be passed a 'ScreenGUI'")
+	gui:Clone().Parent = Players.LocalPlayer.PlayerGui
 
-	gui.Parent = Players.LocalPlayer.PlayerGui
 	table.insert(self.cleanup, gui)
-	return gui
 end
 
 return PlayerUI

src/Features/Players.lua

@@ -12,20 +12,19 @@ local Players = {}
 Players.__index = Players
 
 --- @class Players
---- This is the documentation about Players-related methods.
-
+--- This is the MapLib Feature. It can be accessed by `MapLib:GetFeature("Players")`.
 function Players.new()
 	local self = setmetatable({}, Players)
 	return self
 end
 
---- Used to return all players in the current match.
-function Players:GetPlayers()
+--- Used to return all players in the current round.
+function Players:GetPlayers(): { Player }
 	return PlayerStates:GetPlayersWithState(PlayerStates.GAME)
 end
 
 --[=[
-	@unreleased
+	@since 0.11
 	@within Players
 	This method is used to return players in the radius of the given position.
 ]=]

src/Features/Settings.lua

@@ -12,13 +12,12 @@ if RunService:IsClient() then
 end
 
 --< Main >--
-local Settings = {context = "client"}
+local Settings = { context = "client" }
 Settings.__index = Settings
 
 --- @class Settings
---- This is the documentation about a map's Settings and related methods.
+--- This is the MapLib Feature. It can be accessed by `MapLib:GetFeature("Settings")`.
 
---- @client
 function Settings.new()
 	local self = setmetatable({}, Settings)
 

src/Features/Skills.lua

@@ -6,7 +6,7 @@
 local Skills = {}
 
 --- @class Skills
---- This is the documentation of Skills-related methods.
+--- This is the MapLib Feature. It can be accessed by `MapLib:GetFeature("Skills")`.
 
 function Skills.new(MapLib)
 	local self = setmetatable({}, Skills)