Skip to content

Commit

Permalink
LDoc -Staged reenable Cast comments
Browse files Browse the repository at this point in the history
  • Loading branch information
CuteOne committed Aug 16, 2023
1 parent 190e36b commit 566b14a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 13 deletions.
11 changes: 5 additions & 6 deletions System/API/Buff.lua
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@ module('br.player.buff')
local _, br = ...
if br.api == nil then br.api = {} end

--- Buff is the table located at br.player.buff.
---
-- @description Buff is the table located at br.player.buff
-- These functions are accessible via `local buff = br.player.buff`
-- @section Buff
-- `spell` in the examples represent the name in the buffs list (Spec, Shared Class, Shared Global Lists) defined in System/List/Spells.lua

--- V is the spellID passed from the builder which cycles all the collected buff spells from the spell list for the spec.
-- @param buff table The br.player.buff table.
-- @param v number The spell ID.
-- @usage spell in the examples represent the name in the buffs list (Spec, Shared Class, Shared Global Lists) defined in System/List/Spells.lua
---
-- @section Buff

br.api.buffs = function(buff,v)

Expand Down
12 changes: 5 additions & 7 deletions System/API/Cast.lua
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@ module('br.player.cast')
local _, br = ...
if br.api == nil then br.api = {} end

-- Cast is the table located at br.player.cast.
---
-- @description Cast is the table located at br.player.cast.
-- These functions are accessible via `local cast = br.player.cast`
-- @section Cast
-- `spell` in the examples represent the name in the buffs list (Spec, Shared Class, Shared Global Lists) defined in System/List/Spells.lua

--
-- @description This API provides functions to retrieve information about spell casts.
-- The 'cast' table is located at br.player.cast. Use this in your profile to access the functions.
-- 'id' is the spellID passed from the builder, which cycles through all the collected ability spells from the spell list for the spec.
-- 'spell' in the examples represents the name in the ability list (Spec, Shared Class, Shared Global Lists) defined in System/List/Spells.lua.
---
-- @section Cast

br.api.cast = function(self,spell,id)
if self.cast == nil then self.cast = {} end
Expand Down

0 comments on commit 566b14a

Please sign in to comment.