Format documentation comments for C_LootHistory and C_ToyBox for consistency

This commit is contained in:
2025-05-18 00:50:47 +02:00
parent 9ee4bb792c
commit 377b3b7aa7
2 changed files with 122 additions and 122 deletions

View File

@@ -4,27 +4,27 @@
--- ---
--- @class C_LootHistory --- @class C_LootHistory
C_LootHistory = { C_LootHistory = {
--- @return table --- @return table
--- Returns all encounter information. --- Returns all encounter information.
GetAllEncounterInfos = function() end, GetAllEncounterInfos = function() end,
--- @param encounterID number --- @param encounterID number
--- @return table --- @return table
--- Returns information for a specific encounter. --- Returns information for a specific encounter.
GetInfoForEncounter = function(encounterID) end, GetInfoForEncounter = function(encounterID) end,
--- @return number --- @return number
--- Returns the loot history time. --- Returns the loot history time.
GetLootHistoryTime = function() end, GetLootHistoryTime = function() end,
--- @param encounterID number --- @param encounterID number
--- @return table --- @return table
--- Returns sorted drops for a specific encounter. --- Returns sorted drops for a specific encounter.
GetSortedDropsForEncounter = function(encounterID) end, GetSortedDropsForEncounter = function(encounterID) end,
--- @param encounterID number --- @param encounterID number
--- @param lootListID number --- @param lootListID number
--- @return table --- @return table
--- Returns sorted information for a specific drop. --- Returns sorted information for a specific drop.
GetSortedInfoForDrop = function(encounterID, lootListID) end, GetSortedInfoForDrop = function(encounterID, lootListID) end,
} }

View File

@@ -4,132 +4,132 @@
--- ---
--- @class C_ToyBox --- @class C_ToyBox
C_ToyBox = { C_ToyBox = {
--- @return nil --- @return nil
--- Forces a refilter of toys. --- Forces a refilter of toys.
ForceToyRefilter = function() end, ForceToyRefilter = function() end,
--- @return boolean --- @return boolean
--- Returns whether collected toys are shown. --- Returns whether collected toys are shown.
GetCollectedShown = function() end, GetCollectedShown = function() end,
--- @param itemID number --- @param itemID number
--- @return boolean isFavorite --- @return boolean isFavorite
--- Returns whether a toy is marked as favorite. --- Returns whether a toy is marked as favorite.
GetIsFavorite = function(itemID) end, GetIsFavorite = function(itemID) end,
--- @return number --- @return number
--- Returns the number of filtered toys. --- Returns the number of filtered toys.
GetNumFilteredToys = function() end, GetNumFilteredToys = function() end,
--- @return number --- @return number
--- Returns the number of learned displayed toys. --- Returns the number of learned displayed toys.
GetNumLearnedDisplayedToys = function() end, GetNumLearnedDisplayedToys = function() end,
--- @return number --- @return number
--- Returns the total number of displayed toys. --- Returns the total number of displayed toys.
GetNumTotalDisplayedToys = function() end, GetNumTotalDisplayedToys = function() end,
--- @return number numToys --- @return number numToys
--- Returns the total number of toys. --- Returns the total number of toys.
GetNumToys = function() end, GetNumToys = function() end,
--- @param index number --- @param index number
--- @return number itemID --- @return number itemID
--- Returns the toy ID from the specified index. --- Returns the toy ID from the specified index.
GetToyFromIndex = function(index) end, GetToyFromIndex = function(index) end,
--- @param itemID number --- @param itemID number
--- @return number itemID --- @return number itemID
--- @return string toyName --- @return string toyName
--- @return string icon --- @return string icon
--- @return boolean isFavorite --- @return boolean isFavorite
--- @return boolean hasFanfare --- @return boolean hasFanfare
--- @return number itemQuality --- @return number itemQuality
--- Returns information about a toy. --- Returns information about a toy.
GetToyInfo = function(itemID) end, GetToyInfo = function(itemID) end,
--- @param itemID number --- @param itemID number
--- @return string itemLink --- @return string itemLink
--- Returns the item link for a toy. --- Returns the item link for a toy.
GetToyLink = function(itemID) end, GetToyLink = function(itemID) end,
--- @return boolean --- @return boolean
--- Returns whether uncollected toys are shown. --- Returns whether uncollected toys are shown.
GetUncollectedShown = function() end, GetUncollectedShown = function() end,
--- @return boolean --- @return boolean
--- Returns whether unusable toys are shown. --- Returns whether unusable toys are shown.
GetUnusableShown = function() end, GetUnusableShown = function() end,
--- @return boolean --- @return boolean
--- Returns whether there are any favorites. --- Returns whether there are any favorites.
HasFavorites = function() end, HasFavorites = function() end,
--- @param expansionIndex number --- @param expansionIndex number
--- @return boolean --- @return boolean
--- Returns whether the specified expansion type filter is checked. --- Returns whether the specified expansion type filter is checked.
IsExpansionTypeFilterChecked = function(expansionIndex) end, IsExpansionTypeFilterChecked = function(expansionIndex) end,
--- @param sourceIndex number --- @param sourceIndex number
--- @return boolean --- @return boolean
--- Returns whether the specified source type filter is checked. --- Returns whether the specified source type filter is checked.
IsSourceTypeFilterChecked = function(sourceIndex) end, IsSourceTypeFilterChecked = function(sourceIndex) end,
--- @param itemID number --- @param itemID number
--- @return boolean --- @return boolean
--- Returns whether a toy is usable. --- Returns whether a toy is usable.
IsToyUsable = function(itemID) end, IsToyUsable = function(itemID) end,
--- @param itemID number --- @param itemID number
--- @return nil --- @return nil
--- Picks up a toy box item. --- Picks up a toy box item.
PickupToyBoxItem = function(itemID) end, PickupToyBoxItem = function(itemID) end,
--- @param checked boolean --- @param checked boolean
--- @return nil --- @return nil
--- Sets all expansion type filters. --- Sets all expansion type filters.
SetAllExpansionTypeFilters = function(checked) end, SetAllExpansionTypeFilters = function(checked) end,
--- @param checked boolean --- @param checked boolean
--- @return nil --- @return nil
--- Sets all source type filters. --- Sets all source type filters.
SetAllSourceTypeFilters = function(checked) end, SetAllSourceTypeFilters = function(checked) end,
--- @param checked boolean --- @param checked boolean
--- @return nil --- @return nil
--- Sets whether collected toys are shown. --- Sets whether collected toys are shown.
SetCollectedShown = function(checked) end, SetCollectedShown = function(checked) end,
--- @param expansionIndex number --- @param expansionIndex number
--- @param checked boolean --- @param checked boolean
--- @return nil --- @return nil
--- Sets the specified expansion type filter. --- Sets the specified expansion type filter.
SetExpansionTypeFilter = function(expansionIndex, checked) end, SetExpansionTypeFilter = function(expansionIndex, checked) end,
--- @param searchString string --- @param searchString string
--- @return nil --- @return nil
SetFilterString = function(searchString) end, SetFilterString = function(searchString) end,
--- Sets the filter string for searching toys. --- Sets the filter string for searching toys.
--- @param itemID number --- @param itemID number
--- @param value boolean --- @param value boolean
--- @return nil --- @return nil
--- Sets a toy as favorite or not. --- Sets a toy as favorite or not.
SetIsFavorite = function(itemID, value) end, SetIsFavorite = function(itemID, value) end,
--- @param sourceIndex number --- @param sourceIndex number
--- @param checked boolean --- @param checked boolean
--- @return nil --- @return nil
--- Sets the specified source type filter. --- Sets the specified source type filter.
SetSourceTypeFilter = function(sourceIndex, checked) end, SetSourceTypeFilter = function(sourceIndex, checked) end,
--- @param checked boolean --- @param checked boolean
--- @return nil --- @return nil
--- Sets whether uncollected toys are shown. --- Sets whether uncollected toys are shown.
SetUncollectedShown = function(checked) end, SetUncollectedShown = function(checked) end,
--- @param checked boolean --- @param checked boolean
--- @return nil --- @return nil
--- Sets whether unusable toys are shown. --- Sets whether unusable toys are shown.
SetUnusableShown = function(checked) end, SetUnusableShown = function(checked) end,
} }