Annotations update

This commit is contained in:
Insality
2023-10-17 21:09:45 +03:00
parent 7fc76ed8c0
commit 86b92f90a7
56 changed files with 540 additions and 574 deletions

View File

@@ -21,7 +21,7 @@ local component = require("druid.component")
local Hover = component.create("hover")
--- Component init function
--- The @{Hover} constructor
-- @tparam Hover self @{Hover}
-- @tparam node node Gui node
-- @tparam function on_hover_callback Hover callback
@@ -89,7 +89,7 @@ end
--- Set hover state
-- @tparam Hover self @{Hover}
-- @tparam bool state The hover state
-- @tparam boolean state The hover state
function Hover.set_hover(self, state)
if self._is_hovered ~= state then
self._is_hovered = state
@@ -100,7 +100,7 @@ end
--- Return current hover state. True if touch action was on the node at current time
-- @tparam Hover self @{Hover}
-- @treturn bool The current hovered state
-- @treturn boolean The current hovered state
function Hover.is_hovered(self)
return self._is_hovered
end
@@ -108,7 +108,7 @@ end
--- Set mouse hover state
-- @tparam Hover self @{Hover}
-- @tparam bool state The mouse hover state
-- @tparam boolean state The mouse hover state
function Hover.set_mouse_hover(self, state)
if self._is_mouse_hovered ~= state then
self._is_mouse_hovered = state
@@ -119,7 +119,7 @@ end
--- Return current hover state. True if nil action_id (usually desktop mouse) was on the node at current time
-- @tparam Hover self @{Hover}
-- @treturn bool The current hovered state
-- @treturn boolean The current hovered state
function Hover.is_mouse_hovered(self)
return self._is_mouse_hovered
end
@@ -138,7 +138,7 @@ end
-- If hover is not enabled, it will not generate
-- any hover events
-- @tparam Hover self @{Hover}
-- @tparam bool state The hover enabled state
-- @tparam boolean state The hover enabled state
function Hover.set_enabled(self, state)
self._is_enabled = state
@@ -155,7 +155,7 @@ end
--- Return current hover enabled state
-- @tparam Hover self @{Hover}
-- @treturn bool The hover enabled state
-- @treturn boolean The hover enabled state
function Hover.is_enabled(self)
return self._is_enabled
end