Enhance UnitBuff documentation with detailed parameter and return type annotations

api/UnitBuff.lua

@@ -1,37 +1,40 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param unit string
+---@enum BuffFilter
----@param index number
+---| 'CANCELABLE'
----@param name string
+---| 'NOT_CANCELABLE'
----@param rank string
+---| 'PLAYER'
----@param filter RAID
+---| 'RAID'
----@param CANCELABLE
+---@enum DispellType
----@param NOT_CANCELABLE
+---| 'POISON'
----@param PLAYER
+---| 'DISEASE'
----@param RAID
+---| 'CURSE'
----@return string name
+---| 'MAGIC'
----@return string rank
+
----@return string icon
+---@param unit string The unit to query (e.g., "player", "target").
----@return number count
+---@param index number The index of the aura to query (1-based).
----@return Poison dispelType
+---@param name string The name of the aura to query.
----@return  Curse
+---@param rank string The rank of the aura (e.g., "Rank 7").
----@return  Disease
+---@param filter BuffFilter A filter to specify which auras to return (e.g., "PLAYER|RAID").
----@return  Magic
+---@return string #name The name of the aura.
----@return  Poison
+---@return string #rank The rank of the aura, if applicable.
----@return number duration
+---@return string #icon The path to the icon texture for the aura.
----@return number expires
+---@return number #count The number of times the aura has been applied.
----@return string caster
+---@return DispellType #dispelType The type of aura (e.g., "POISON", "MAGIC").
----@return boolean isStealable
+---@return number #duration The total duration of the aura in seconds.
----@return boolean nameplateShowPersonal
+---@return number #expires The time at which the aura will expire.
----@return number spellID
+---@return string #caster The unit that applied the aura.
----@return boolean canApplyAura
+---@return boolean #isStealable True if the aura can be stolen.
----@return boolean isBossDebuff
+---@return boolean #nameplateShowPersonal True if the aura is visible above nameplates for the caster.
----@return boolean _
+---@return number #spellID The spell ID of the aura.
----@return boolean nameplateShowAll
+---@return boolean #canApplyAura True if the player can apply the aura.
----@return number timeMod
+---@return boolean #isBossDebuff True if the aura was cast by a boss.
----@return number value1
+---@return boolean _ Unknown parameter.
----@return number value2
+---@return boolean nameplateShowAll True if the aura is visible above nameplates for all players.
----@return number value3
+---@return number timeMod The modified time remaining on the aura.
----Returns information about a buff on a unit. This function is an alias for UnitAura() with a built-in HELPFUL filter (which cannot be removed or negated with the HARMFUL filter).
+---@return number value1 Value of variable effect 1 of the aura.
-function UnitBuff(unit, index, name, rank, filter, CANCELABLE, NOT_CANCELABLE, PLAYER, RAID) end
+---@return number value2 Value of variable effect 2 of the aura.
+---@return number value3 Value of variable effect 3 of the aura.
+--- Returns information about a buff on a unit. This function is an alias for UnitAura() with a built-in HELPFUL filter.
+function UnitBuff(unit, index, name, rank, filter) end