Refactor calendar event functions to enhance parameter aliasing and improve documentation clarity

api/CalendarGetDayEvent.lua

@@ -1,54 +1,30 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param monthOffset 1 
----@param -1  
----@param 0  
----@param 1  
----@param day number 
----@param index number 
----@return string title 
----@return number hour 
----@return number minute 
----@return SYSTEM calendarType 
----@return  GUILD_ANNOUNCEMENT 
----@return  GUILD_EVENT 
----@return  HOLIDAY 
----@return  PLAYER 
----@return  RAID_LOCKOUT 
----@return  RAID_RESET 
----@return  SYSTEM 
----@return START sequenceType 
----@return  END 
----@return  INFO 
----@return  ONGOING 
----@return  START 
----@return 5 eventType 
----@return  0 
----@return  1 
----@return  2 
----@return  3 
----@return  4 
----@return  5 
----@return string texture 
----@return MODERATOR modStatus 
----@return  CREATOR 
----@return  MODERATOR 
----@return 8 inviteStatus 
----@return  1 
----@return  2 
----@return  3 
----@return  4 
----@return  5 
----@return  6 
----@return  7 
----@return  8 
----@return string invitedBy 
----@return 2 difficulty 
----@return  1 
----@return  2 
----@return 2 inviteType 
----@return  1 
----@return  2 
+---@alias sequenceType
+---| "END" Last day of the event
+---| "INFO" An additional specially-labeled day related the event
+---| "ONGOING" Continuation of the event
+---| "START" First day of the event
+
+---@alias difficulty
+---| 1 Normal
+---| 2 Heroic
+
+---@param monthOffset monthOffset
+---@param day number
+---@param index number #Index of an event on the given day (from 1 to CalendarGetNumDayEvents()) (number)
+---@return string title
+---@return number hour
+---@return number minute
+---@return calendarType calendarType
+---@return sequenceType sequenceType
+---@return number eventType
+---@return number texture
+---@return modStatus modStatus
+---@return inviteStatus inviteStatus
+---@return string invitedBy
+---@return difficulty difficulty
+---@return inviteType inviteType
 ---Returns information about a calendar event on a given day. Information can only be retrieved for events which might be visible in the calendar's current month -- i.e. those in the current month as well as those in (roughly) the last week of the previous month and (roughly) the first two weeks of the following month. To reliably retrieve information for events outside the calendar's current month, first change the calendar's month with CalendarSetMonth.
-function CalendarGetDayEvent(monthOffset, -1, 0, 1, day, index) end
+function CalendarGetDayEvent(monthOffset, day, index) end