Added more comments to some functions

features/eid_holdmapdesc.lua

@@ -506,7 +506,8 @@ function EID:ItemReminderAddSpecialDescriptions(player)
 	end
 end
 
--- Information about the player character's traits
+-- Item Reminder function: Information about the player character's traits
+---@param player EntityPlayer
 function EID:ItemReminderHandleCharacterInfo(player)
 	local playerType = player:GetPlayerType()
 	local playerDesc = EID:getDescriptionEntry("CharacterInfo")[playerType]
@@ -515,7 +516,8 @@ function EID:ItemReminderHandleCharacterInfo(player)
 	end
 end
 
--- Passive Item Descriptions
+-- Item Reminder function: Passive Item Descriptions
+---@param player EntityPlayer
 function EID:ItemReminderHandleSelectedPassiveItem(player)
 	local playerNum = EID:getPlayerID(player, true)
 	if EID.RecentlyTouchedItems[playerNum] and #EID.RecentlyTouchedItems[playerNum] > 0 then
@@ -523,7 +525,8 @@ function EID:ItemReminderHandleSelectedPassiveItem(player)
 	end
 end
 
--- Active Item Descriptions
+-- Item Reminder function: Active Item Descriptions
+---@param player EntityPlayer
 function EID:ItemReminderHandleActiveItems(player)
 	-- limit number of active item descriptions to 2, since Slot 3 and 4 are handled seperately
 	for i = 0, 1 do
@@ -536,7 +539,8 @@ function EID:ItemReminderHandleActiveItems(player)
 	end
 end
 
--- pocket active
+-- Item Reminder function: pocket actives
+---@param player EntityPlayer
 function EID:ItemReminderHandlePocketActive(player)
 	if not EID.isRepentance or not EID:ItemReminderCanAddMoreToView() then return end
 	local pocketActive = player:GetActiveItem(2) or 0
@@ -545,7 +549,8 @@ function EID:ItemReminderHandlePocketActive(player)
 	end
 end
 
--- dice bag
+-- Item Reminder function: dice bag
+---@param player EntityPlayer
 function EID:ItemReminderHandleDiceBag(player)
 	if not EID.isRepentance or not EID:ItemReminderCanAddMoreToView()  then return end
 
@@ -555,7 +560,8 @@ function EID:ItemReminderHandleDiceBag(player)
 	end
 end
 
--- Pocket Item Descriptions
+-- Item Reminder function: Pocket Item Descriptions
+---@param player EntityPlayer
 function EID:ItemReminderHandlePocketItems(player)
 	for i = 0, 2 do
 		if not EID:ItemReminderCanAddMoreToView() then return end
@@ -576,7 +582,9 @@ function EID:ItemReminderHandlePocketItems(player)
 	end
 end
 
--- Held trinkets are added at the end of the table; use this table in descending order
+-- Item Reminder function: Held trinkets are added at the end of the table; use this table in descending order
+---@param player EntityPlayer
+---@diagnostic disable-next-line: duplicate-set-field
 function EID:ItemReminderHeldPlusGulped(player)
 	local playerNum = EID:getPlayerID(player, true)
 	local newTable = {}
@@ -587,12 +595,14 @@ function EID:ItemReminderHeldPlusGulped(player)
 	end
 	return newTable
 end
--- Trinket Descriptions
+-- Item Reminder function: Trinket Descriptions
+---@param player EntityPlayer
 function EID:ItemReminderHandleTrinkets(player)
 	EID:ItemReminderHandleItemPrinting(player, EID:ItemReminderHeldPlusGulped(player), 350, true)
 end
 
--- Tainted ??? Poop Descriptions
+-- Item Reminder function: Tainted ??? Poop Descriptions
+---@param player EntityPlayer
 function EID:ItemReminderHandlePoopSpells(player)
 	if EID.isRepentance and player:GetPlayerType() == 25 and EID:ItemReminderCanAddMoreToView() then
 		local poopInfo = EID:getDescriptionEntry("poopSpells")
@@ -646,13 +656,14 @@ function EID:ItemReminderHandlePoopSpells(player)
 	end
 end
 
--- Lemegeton wisp descriptions
+-- Item Reminder function: Lemegeton wisp descriptions
+---@param player EntityPlayer
 function EID:ItemReminderHandleLemegetonWisps(player)
 	local playerNum = EID:getPlayerID(player, true)
 	EID:ItemReminderHandleItemPrinting(player, EID.WispsPerPlayer[playerNum], 100, false)
 end
 
--- Handle scroll inputs
+-- Item Reminder function: Handle scroll inputs
 function EID:ItemReminderHandleInputs()
 	if EID.Config["ItemReminderEnabled"] and EID.Config["ItemReminderDisplayMode"] ~= "Classic" and EID.holdTabCounter >= 30 and EID.TabDescThisFrame == false and EID.holdTabPlayer ~= nil then
 		if EID.Config["ItemReminderDisableInputs"] then EID.holdTabPlayer.ControlsCooldown = 2 end
@@ -695,10 +706,10 @@ function EID:ItemReminderHandleInputs()
 	end
 end
 
--- special list of all players, ignoring tainted forgotten ghost and coop babies
+-- Item Reminder function: special list of all players, ignoring tainted forgotten ghost and coop babies
 function EID:ItemReminderGetAllPlayers()
 	local filteredPlayerList = {}
-	for i, player in ipairs(EID.coopAllPlayers) do
+	for _, player in ipairs(EID.coopAllPlayers) do
 		if not (EID.isRepentance and player:GetPlayerType() == PlayerType.PLAYER_THESOUL_B) and player:GetBabySkin() == -1 then
 			table.insert(filteredPlayerList, player)		
 		end
@@ -706,14 +717,20 @@ function EID:ItemReminderGetAllPlayers()
 	return filteredPlayerList
 end
 
+-- Item Reminder function: check if the currently selected category is scrollable
+---@return boolean
 function EID:IsScrollableCategorySelected()
 	return EID.ItemReminderCategories[EID.ItemReminderSelectedCategory + 1].isScrollable
 end
 
+-- Item Reminder function: check if the given category is currently selected
+---@param categoryID integer
+---@return boolean
 function EID:IsCategorySelected(categoryID)
 	return EID.ItemReminderCategories[EID.ItemReminderSelectedCategory + 1].id == categoryID
 end
 
+-- Item Reminder function: Resets data when initializing holding TAB
 function EID:ItemReminderHandleInitHoldTab()
 	local oldDisplayPlayer = EID.ItemReminderSelectedPlayer
 
@@ -734,6 +751,8 @@ function EID:ItemReminderHandleInitHoldTab()
 	end
 end
 
+--- Returns the title of the currently selected Item Reminder category.
+---@return string
 function EID:ItemReminderGetTitle()
 	local category = EID.ItemReminderCategories[EID.ItemReminderSelectedCategory + 1]
 
@@ -836,19 +855,21 @@ function EID:ItemReminderHandleItemPrinting(player, entryTable, itemVariant, des
 	
 	if descending then
 		local startIndex = (#entryTable - EID.ItemReminderSelectedItems[EID.ItemReminderSelectedCategory] - 1) % #entryTable
-		for i = 1, descsToDisplay do
+		for _ = 1, descsToDisplay do
 			EID:ItemReminderAddDescription(player, 5, itemVariant, entryTable[startIndex+1] % GLITCH_ITEM_FLAG)
 			startIndex = (startIndex - 1) % #entryTable
 		end
 	else
 		local startIndex = EID.ItemReminderSelectedItems[EID.ItemReminderSelectedCategory] % #entryTable
-		for i = 1, descsToDisplay do
+		for _ = 1, descsToDisplay do
 			EID:ItemReminderAddDescription(player, 5, itemVariant, entryTable[startIndex+1] % GLITCH_ITEM_FLAG)
 			startIndex = (startIndex + 1) % #entryTable
 		end
 	end
 end
 
+--- Generates the description for the Item Reminder, based on the currently selected category and player.
+---@return string
 function EID:ItemReminderGetDescription()
 	EID.InsideItemReminder = true
 	EID.ItemReminderTempDescriptions = {}