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

api/CalendarEventGetCalendarType.lua

@@ -1,9 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@return PLAYER calendarType
+---@return calendarType
----@return  GUILD_ANNOUNCEMENT
----@return  GUILD_EVENT
----@return  PLAYER
 ---Returns the type of the selected calendar event
 function CalendarEventGetCalendarType() end

api/CalendarEventGetInvite.lua

@@ -6,20 +6,9 @@
 ---@return number level
 ---@return string className
 ---@return string classFileName
----@return 7 inviteStatus
+---@return inviteStatus
----@return  1
+---@return modStatus
----@return  2
----@return  3
----@return  4
----@return  5
----@return  6
----@return  7
----@return MODERATOR modStatus
----@return  CREATOR
----@return  MODERATOR
 ---@return boolean inviteIsMine
----@return 2 inviteType
+---@return inviteType
----@return  1
----@return  2
 ---Returns information about an entry in the selected event's invite/signup list
 function CalendarEventGetInvite(index) end

api/CalendarEventGetInviteSortCriterion.lua

@@ -1,10 +1,12 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@return status criterion
+---@alias criterion
----@return CLASS_SORT_ORDER class
+---| "CLASS" Sorted by character class (according to the global table CLASS_SORT_ORDER)
----@return  name
+---| "NAME" Sorted by character name
----@return  status
+---| "STATUS" Sorted by invite status
+
+---@return criterion
 ---@return boolean reverse
 ---Returns the current sort mode for the event invite/signup list
 function CalendarEventGetInviteSortCriterion() end

api/CalendarEventGetRepeatOptions.lua

@@ -1,6 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@return list ...
+---@return string[]
 ---Returns a list of localized event repetition option labels (currently unused)
 function CalendarEventGetRepeatOptions() end

api/CalendarEventGetStatusOptions.lua

@@ -1,6 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@return list ...
+---@return string[]
 ---Returns a list of localized invite status labels
 function CalendarEventGetStatusOptions() end

api/CalendarEventGetTextures.lua

@@ -1,11 +1,13 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param eventType 2 
+---@alias eventType
----@param 1  
+---| 1 Raid dungeon
----@param 2  
+---| 2 Five-player dungeon
----@return string name 
+
----@return string icon 
+---@param eventType eventType
----@return number expansion 
+---@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

api/CalendarEventGetTypes.lua

@@ -1,6 +1,6 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@return list ...
+---@return string[]
 ---Returns a list of event display style labels
 function CalendarEventGetTypes() end