Add more type hints and corrections

Author: vaisest

src/Classes/CalcsTab.lua

@@ -17,6 +17,8 @@ local buffModeDropList = {
 }
 
 ---@class CalcsTab: UndoHandler, ControlHost, Control
+---@field powerStat PowerStat?
+---@field nodePowerMaxDepth integer? Maximum distance for power report
 local CalcsTabClass = newClass("CalcsTab", "UndoHandler", "ControlHost", "Control")
 
 ---@param build Build
@@ -163,7 +165,7 @@ function CalcsTabClass:Load(xml, dbFileName)
 		if type(node) == "table" then
 			if node.elem == "Input" then
 				if not node.attrib.name then
-					launch:ShowErrMsg("^1Error parsing '%s': 'Input' element missing name attribute", fileName)
+					launch:ShowErrMsg("^1Error parsing '%s': 'Input' element missing name attribute", dbFileName)
 					return true
 				end
 				if node.attrib.number then
@@ -173,12 +175,12 @@ function CalcsTabClass:Load(xml, dbFileName)
 				elseif node.attrib.boolean then
 					self.input[node.attrib.name] = node.attrib.boolean == "true"
 				else
-					launch:ShowErrMsg("^1Error parsing '%s': 'Input' element missing number, string or boolean attribute", fileName)
+					launch:ShowErrMsg("^1Error parsing '%s': 'Input' element missing number, string or boolean attribute", dbFileName)
 					return true
 				end
 			elseif node.elem == "Section" then
 				if not node.attrib.id then
-					launch:ShowErrMsg("^1Error parsing '%s': 'Section' element missing id attribute", fileName)
+					launch:ShowErrMsg("^1Error parsing '%s': 'Section' element missing id attribute", dbFileName)
 					return true
 				end
 				for _, section in ipairs(self.sectionList) do

src/Classes/DraggerControl.lua

@@ -3,7 +3,7 @@
 -- Class: Dragger Button Control
 -- Dragger button control.
 --
----@type DraggerControl: Control, TooltipHost
+---@class DraggerControl: Control, TooltipHost
 local DraggerClass = newClass("DraggerControl", "Control", "TooltipHost")
 
 function DraggerClass:DraggerControl(anchor, rect, label, onKeyDown, onKeyUp, onRightClick, onHover, forceTooltip)

src/Classes/EditControl.lua

@@ -37,6 +37,7 @@ local function newlineCount(str)
 end
 
 ---@class EditControl: ControlHost, Control, UndoHandler, TooltipHost
+---@field inactiveText (fun(buf: string?): string)|string
 local EditClass = newClass("EditControl", "ControlHost", "Control", "UndoHandler", "TooltipHost")
 
 function EditClass:EditControl(anchor, rect, init, prompt, filter, limit, changeFunc, lineHeight, allowZoom, clearable)
@@ -301,7 +302,8 @@ function EditClass:Draw(viewPort, noTooltip)
 		else
 			SetDrawColor(self.inactiveCol)
 			if self.inactiveText then
-				local inactiveText = type(inactiveText) == "string" and self.inactiveText or self.inactiveText(self.buf)
+				local inactiveText = type(self.inactiveText) == "string" and self.inactiveText or self.inactiveText(self.buf)
+				---@cast inactiveText string
 				DrawString(-self.controls.scrollBarH.offset, -self.controls.scrollBarV.offset, "LEFT", textHeight, self.font, inactiveText)
 			elseif self.protected then
 				DrawString(-self.controls.scrollBarH.offset, -self.controls.scrollBarV.offset, "LEFT", textHeight, self.font, string.rep(protected_replace, #self.buf))

src/Classes/PassiveTree.lua

@@ -49,7 +49,26 @@ local function getFile(URL)
 	return #page > 0 and page
 end
 
+---@class PassiveTreeGroup
+---@field x number
+---@field y number
+---@field orbits integer[]
+---@field nodes string[]
+---@field background any
+---@field isProxy boolean?
 ---@class PassiveTree
+---@field classes any[] A list of classes on the tree
+---@field alternate_ascendancies any[]?
+---@field tree "Default"|"DefaultAltAscendancies"
+---@field groups PassiveTreeGroup[]
+---@field nodes table<"root"|integer, any>
+---@field jewelSlots integer[]
+---@field min_x integer
+---@field min_y integer
+---@field max_x integer
+---@field max_y integer
+---@field constants table<string, any>
+---@field points table<string, integer>
 local PassiveTreeClass = newClass("PassiveTree")
 
 function PassiveTreeClass:PassiveTree(treeVersion)

src/Classes/PassiveTreeView.lua

@@ -15,6 +15,7 @@ local band = bit.band
 local b_rshift = bit.rshift
 
 ---@class PassiveTreeView
+---@field compareSpec? PassiveSpec
 local PassiveTreeViewClass = newClass("PassiveTreeView")
 
 function PassiveTreeViewClass:PassiveTreeView()
@@ -171,6 +172,7 @@ function PassiveTreeViewClass:GetCompareNodeColor(node, compareNode, spec, build
 	return nodeDefaultColor
 end
 
+---@param build Build
 function PassiveTreeViewClass:Draw(build, viewPort, inputEvents)
 	local spec = build.spec
 	local tree = spec.tree

src/Classes/UndoHandler.lua

@@ -10,6 +10,8 @@ local t_insert = table.insert
 local t_remove = table.remove
 
 ---@class UndoHandler
+---@field CreateUndoState fun() Must be manually defined. Creates a state that can be restored
+---@field RestoreUndoState fun(state: any) Must be manually defined. Restores a state created by calling CreateUndoState()
 local UndoHandlerClass = newClass("UndoHandler")
 
 function UndoHandlerClass:UndoHandler()
@@ -28,6 +30,7 @@ end
 
 -- Adds a new undo state to the undo buffer, and also clears the redo buffer
 -- Should be called after the user makes a change to the current state
+---@param noClearRedo boolean?
 function UndoHandlerClass:AddUndoState(noClearRedo)
 	t_insert(self.undo, 1, self:CreateUndoState())
 	self.undo[102] = nil

src/Modules/Build.lua

@@ -16,6 +16,7 @@ local s_format = string.format
 
 ---@class Build: ControlHost
 ---@field spec PassiveSpec added by TreeTab
+---@field powerBuilderCallback fun()
 local buildMode = new("ControlHost"):ControlHost()
 
 local function InsertIfNew(t, val)

src/Modules/CalcDefence.lua

@@ -54,7 +54,7 @@ end
 -- Based on code from FR and BS found in act_*.txt
 ---@param activeSkill any /output/breakdown references table passed in from calc offence
 ---@param sourceType string type of incoming damage - it will be converted (taken as) from this type if applicable
----@param baseDmg for which to calculate the damage
+---@param baseDmg number for which to calculate the damage
 ---@return table of taken damage parts, and number, sum of damages
 function calcs.applyDmgTakenConversion(activeSkill, output, breakdown, sourceType, baseDmg)
 	local damageBreakdown = { }

src/Modules/CalcTools.lua

@@ -244,7 +244,7 @@ end
 --- Correct the tags on conversion with multipliers so they carry over correctly
 --- @param mod table
 --- @param multiplier number
---- @param minionMods bool @convert ActorConditions pointing at parent to normal Conditions
+--- @param minionMods boolean @convert ActorConditions pointing at parent to normal Conditions
 --- @return table @converted multipliers
 function calcLib.getConvertedModTags(mod, multiplier, minionMods)
 	local modifiers = { }
@@ -284,7 +284,7 @@ end
 
 --- Use getGameIdFromGemName to get gameId from the gemName and passed in type. Return true if they're the same and not nil
 --- @param gemName string
---- @param type string
+--- @param typeName string
 --- @param dropVaal boolean 
 --- @return boolean
 function calcLib.isGemIdSame(gemName, typeName, dropVaal)

src/Modules/Common.lua

@@ -437,6 +437,10 @@ function writeLuaTable(out, t, indent)
 end
 
 -- Make a copy of a table and all subtables
+---@generic T
+---@param tbl T
+---@param noRecurse boolean?
+---@return T copy Note that this type can be misleading if noRecurse is set to true. Type hint explicitly if necessary.
 function copyTable(tbl, noRecurse)
 	local out = {}
 	for k, v in pairs(tbl) do