Enhance documentation for calendar event functions by refining return types and parameter aliases

This commit is contained in:
2025-05-18 00:57:12 +02:00
parent e01a681d66
commit 11f27b18de
7 changed files with 22 additions and 32 deletions

View File

@@ -1,11 +1,13 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param eventType 2
---@param 1
---@param 2
---@return string name
---@return string icon
---@return number expansion
---@alias eventType
---| 1 Raid dungeon
---| 2 Five-player dungeon
---@param eventType eventType
---@param expansion number Expansion to which the instance belongs; localized names can be found in the constants EXPANSION_NAME0, EXPANSION_NAME1, etc. (number)
---@return string name
---@return string icon #Unique part of the path to the instance's icon texture; for the full path, prepend with "Interface\LFGFrame\LFGIcon-"
---Returns a list of instance names and icons for dungeon or raid events
function CalendarEventGetTextures(eventType, 1, 2) end
function CalendarEventGetTextures(eventType, expansion) end