Update annotations

README.md

@@ -185,7 +185,7 @@ For a complete overview, see: **_[components.md](docs_md/01-components.md)_**.
 
 ## Druid Events
 
-Any **Druid** components as callbacks use [Druid Events](https://insality.github.io/druid/modules/DruidEvent.html). In component API ([button example](https://insality.github.io/druid/modules/Button.html#on_click)) pointed list of component events. You can manually subscribe to these events with the following API:
+Any **Druid** components as callbacks use [Druid Events](https://insality.github.io/druid/modules/druid.event.html). In component API ([button example](https://insality.github.io/druid/modules/Button.html#on_click)) pointed list of component events. You can manually subscribe to these events with the following API:
 
 - **event:subscribe**(callback)
 

druid/base/button.lua

@@ -35,27 +35,27 @@
 -- @alias druid.button
 
 
---- The DruidEvent: Event on successful release action over button.
+--- The druid.event: Event on successful release action over button.
 -- @usage
 -- -- Custom args passed in Button constructor
 -- button.on_click:subscribe(function(self, custom_args, button_instance)
 --     print("On button click!")
 -- end)
--- @tfield DruidEvent on_click DruidEvent
+-- @tfield druid.event on_click druid.event
 
 
---- The DruidEvent: Event on repeated action over button.
+--- The druid.event: Event on repeated action over button.
 --
 -- This callback will be triggered if user hold the button. The repeat rate pick from `input.repeat_interval` in game.project
 -- @usage
 -- -- Custom args passed in Button constructor
 -- button.on_repeated_click:subscribe(function(self, custom_args, button_instance, click_count)
 --     print("On repeated Button click!")
 -- end)
--- @tfield DruidEvent on_repeated_click DruidEvent
+-- @tfield druid.event on_repeated_click druid.event
 
 
---- The DruidEvent: Event on long tap action over button.
+--- The druid.event: Event on long tap action over button.
 --
 -- This callback will be triggered if user pressed the button and hold the some amount of time.
 -- The amount of time picked from button style param: LONGTAP_TIME
@@ -64,10 +64,10 @@
 -- button.on_long_click:subscribe(function(self, custom_args, button_instance, hold_time)
 --     print("On long Button click!")
 -- end)
--- @tfield DruidEvent on_long_click DruidEvent
+-- @tfield druid.event on_long_click druid.event
 
 
---- The DruidEvent: Event on double tap action over button.
+--- The druid.event: Event on double tap action over button.
 --
 -- If secondary click was too fast after previous one, the double
 -- click will be called instead usual click (if on_double_click subscriber exists)
@@ -76,10 +76,10 @@
 -- button.on_double_click:subscribe(function(self, custom_args, button_instance, click_amount)
 --     print("On double Button click!")
 -- end)
--- @tfield DruidEvent on_double_click DruidEvent
+-- @tfield druid.event on_double_click druid.event
 
 
---- The DruidEvent: Event calls every frame before on_long_click event.
+--- The druid.event: Event calls every frame before on_long_click event.
 --
 -- If long_click subscriber exists, the on_hold_callback will be called before long_click trigger.
 --
@@ -89,10 +89,10 @@
 -- button.on_double_click:subscribe(function(self, custom_args, button_instance, time)
 --     print("On hold Button callback!")
 -- end)
--- @tfield DruidEvent on_hold_callback DruidEvent
+-- @tfield druid.event on_hold_callback druid.event
 
 
---- The DruidEvent: Event calls if click event was outside of button.
+--- The druid.event: Event calls if click event was outside of button.
 --
 -- This event will be triggered for each button what was not clicked on user click action
 --
@@ -102,16 +102,16 @@
 -- button.on_click_outside:subscribe(function(self, custom_args, button_instance)
 --     print("On click Button outside!")
 -- end)
--- @tfield DruidEvent on_click_outside DruidEvent
+-- @tfield druid.event on_click_outside druid.event
 
 
---- The DruidEvent: Event triggered if button was pressed by user.
+--- The druid.event: Event triggered if button was pressed by user.
 -- @usage
 -- -- Custom args passed in Button constructor
 -- button.on_pressed:subscribe(function(self, custom_args, button_instance)
 --     print("On Button pressed!")
 -- end)
--- @tfield DruidEvent on_pressed DruidEvent
+-- @tfield druid.event on_pressed druid.event
 
 --- Button trigger node
 -- @tfield node node
@@ -279,17 +279,19 @@ end
 
 
 --- Component style params.
--- You can override this component styles params in Druid styles table
--- or create your own style
--- @table style
--- @tfield number|nil LONGTAP_TIME Minimum time to trigger on_hold_callback. Default: 0.4
--- @tfield number|nil AUTOHOLD_TRIGGER Maximum hold time to trigger button release while holding. Default: 0.8
--- @tfield number|nil DOUBLETAP_TIME Time between double taps. Default: 0.4
--- @tfield function on_click function(self, node)
--- @tfield function on_click_disabled function(self, node)
--- @tfield function on_hover function(self, node, hover_state)
--- @tfield function on_mouse_hover function(self, node, hover_state)
--- @tfield function on_set_enabled function(self, node, enabled_state)
+---You can override this component styles params in Druid styles table
+---or create your own style
+---@class druid.button.style
+---@field LONGTAP_TIME number|nil Minimum time to trigger on_hold_callback. Default: 0.4
+---@field AUTOHOLD_TRIGGER number|nil Maximum hold time to trigger button release while holding. Default: 0.8
+---@field DOUBLETAP_TIME number|nil Time between double taps. Default: 0.4
+---@field on_click fun(self, node)|nil
+---@field on_click_disabled fun(self, node)|nil
+---@field on_hover fun(self, node, hover_state)|nil
+---@field on_mouse_hover fun(self, node, hover_state)|nil
+---@field on_set_enabled fun(self, node, enabled_state)|nil
+
+---@param style druid.button.style
 function M:on_style_change(style)
 	self.style = {}
 	self.style.LONGTAP_TIME = style.LONGTAP_TIME or 0.4
@@ -469,12 +471,8 @@ end
 --- Set button enabled state.
 -- The style.on_set_enabled will be triggered.
 -- Disabled button is not clickable.
--- @tparam Button self Button
 -- @tparam boolean|nil state Enabled state
--- @treturn Button Current button instance
--- @usage
--- button:set_enabled(false)
--- button:set_enabled(true)
+---@return druid.button self
 function M:set_enabled(state)
 	self.disabled = not state
 	self.hover:set_enabled(state)
@@ -487,10 +485,7 @@ end
 --- Get button enabled state.
 --
 -- By default all Buttons is enabled on creating.
--- @tparam Button self Button
--- @treturn boolean @True, if button is enabled now, False overwise
--- @usage
--- local is_enabled = button:is_enabled()
+---@return boolean @True, if button is enabled now, False overwise
 function M:is_enabled()
 	return not self.disabled
 end
@@ -500,11 +495,8 @@ end
 -- Useful to restrict click outside out stencil node or scrollable content.
 --
 -- This functions calls automatically if you don't disable it in game.project: druid.no_stencil_check
--- @tparam Button self Button
 -- @tparam node|string|nil zone Gui node
--- @treturn Button Current button instance
--- @usage
--- button:set_click_zone("stencil_node")
+---@return druid.button self
 function M:set_click_zone(zone)
 	self.click_zone = self:get_node(zone)
 	self.hover:set_click_zone(zone)
@@ -513,12 +505,9 @@ function M:set_click_zone(zone)
 end
 
 
---- Set key name to trigger this button by keyboard.
--- @tparam Button self Button
--- @tparam hash|string key The action_id of the input key
--- @treturn Button Current button instance
--- @usage
--- button:set_key_trigger("key_space")
+---Set key name to trigger this button by keyboard.
+---@param key hash|string The action_id of the input key. Example: "key_space"
+---@return druid.button self
 function M:set_key_trigger(key)
 	self.key_trigger = hash(key)
 
@@ -527,20 +516,16 @@ end
 
 
 --- Get current key name to trigger this button.
--- @tparam Button self
--- @treturn hash The action_id of the input key
--- @usage
--- local key_hash = button:get_key_trigger()
+---@return hash key_trigger The action_id of the input key
 function M:get_key_trigger()
 	return self.key_trigger
 end
 
 
 --- Set function for additional check for button click availability
--- @tparam Button self
 -- @tparam function|nil check_function Should return true or false. If true - button can be pressed.
 -- @tparam function|nil failure_callback Function will be called on button click, if check function return false
--- @treturn Button Current button instance
+---@return druid.button self
 function M:set_check_function(check_function, failure_callback)
 	self._check_function = check_function
 	self._failure_callback = failure_callback
@@ -553,11 +538,8 @@ end
 -- The HTML5 button's doesn't call any events except on_click event.
 --
 -- If the game is not HTML, html mode will be not enabled
--- @tparam Button self
 -- @tparam boolean|nil is_web_mode If true - button will be called inside html5 callback
--- @treturn Button Current button instance
--- @usage
--- button:set_web_user_interaction(true)
+---@return druid.button self
 function M:set_web_user_interaction(is_web_mode)
 	self._is_html5_mode = not not (is_web_mode and html5)
 	return self

druid/base/drag.lua

@@ -14,19 +14,19 @@
 -- @tfield node node
 
 --- Event on touch start callback(self)
--- @tfield DruidEvent on_touch_start DruidEvent
+-- @tfield druid.event on_touch_start druid.event
 
 --- Event on touch end callback(self)
--- @tfield DruidEvent on_touch_end DruidEvent
+-- @tfield druid.event on_touch_end druid.event
 
 --- Event on drag start callback(self, touch)
--- @tfield DruidEvent on_drag_start DruidEvent
+-- @tfield druid.event on_drag_start druid.event
 
 --- on drag progress callback(self, dx, dy, total_x, total_y, touch)
--- @tfield DruidEvent on_drag Event DruidEvent
+-- @tfield druid.event on_drag Event druid.event
 
 --- Event on drag end callback(self, total_x, total_y, touch)
--- @tfield DruidEvent on_drag_end DruidEvent
+-- @tfield druid.event on_drag_end druid.event
 
 --- Is component now touching
 -- @tfield boolean is_touch

druid/base/hover.lua

@@ -9,10 +9,10 @@
 -- @tfield node node
 
 --- On hover callback(self, state, hover_instance)
--- @tfield DruidEvent on_hover DruidEvent
+-- @tfield druid.event on_hover druid.event
 
 --- On mouse hover callback(self, state, hover_instance)
--- @tfield DruidEvent on_mouse_hover DruidEvent
+-- @tfield druid.event on_mouse_hover druid.event
 
 ---
 

druid/base/scroll.lua

@@ -39,13 +39,13 @@
 
 
 --- On scroll move callback(self, position)
--- @tfield DruidEvent on_scroll DruidEvent
+-- @tfield druid.event on_scroll druid.event
 
 --- On scroll_to function callback(self, target, is_instant)
--- @tfield DruidEvent on_scroll_to DruidEvent
+-- @tfield druid.event on_scroll_to druid.event
 
 --- On scroll_to_index function callback(self, index, point)
--- @tfield DruidEvent on_point_scroll DruidEvent
+-- @tfield druid.event on_point_scroll druid.event
 
 --- Scroll view node
 -- @tfield node view_node
@@ -651,7 +651,7 @@ end
 --- Find closer point of interest
 -- if no inert, scroll to next point by scroll direction
 -- if inert, find next point by scroll director
--- @local
+---@private
 function M:_check_points()
 	if not self.points then
 		return

druid/base/static_grid.lua

@@ -37,19 +37,19 @@
 -- @alias druid.static_grid
 
 --- On item add callback(self, node, index)
--- @tfield DruidEvent on_add_item DruidEvent
+-- @tfield druid.event on_add_item druid.event
 
 --- On item remove callback(self, index)
--- @tfield DruidEvent on_remove_item DruidEvent
+-- @tfield druid.event on_remove_item druid.event
 
 --- On item add, remove or change in_row callback(self, index|nil)
--- @tfield DruidEvent on_change_items DruidEvent
+-- @tfield druid.event on_change_items druid.event
 
 --- On grid clear callback(self)
--- @tfield DruidEvent on_clear DruidEvent
+-- @tfield druid.event on_clear druid.event
 
 --- On update item positions callback(self)
--- @tfield DruidEvent on_update_positions DruidEvent
+-- @tfield druid.event on_update_positions druid.event
 
 --- Parent gui node
 -- @tfield node parent
@@ -491,7 +491,7 @@ end
 --- Update grid inner state
 -- @tparam StaticGrid self StaticGrid
 -- @tparam boolean|nil is_instant If true, node position update instantly, otherwise with set_position_function callback
--- @local
+---@private
 function M:_update(is_instant)
 	self:_update_indexes()
 	self:_update_borders()
@@ -501,7 +501,7 @@ end
 
 --- Update first and last indexes of grid nodes
 -- @tparam StaticGrid self StaticGrid
--- @local
+---@private
 function M:_update_indexes()
 	self.first_index = nil
 	self.last_index = nil
@@ -517,7 +517,7 @@ end
 
 --- Update grid content borders, recalculate min and max values
 -- @tparam StaticGrid self StaticGrid
--- @local
+---@private
 function M:_update_borders()
 	if not self.first_index then
 		self.border = vmath.vector4(0)
@@ -537,7 +537,7 @@ end
 --- Update grid nodes position
 -- @tparam StaticGrid self StaticGrid
 -- @tparam boolean|nil is_instant If true, node position update instantly, otherwise with set_position_function callback
--- @local
+---@private
 function M:_update_pos(is_instant)
 	local zero_offset = self:_get_zero_offset()
 
@@ -560,7 +560,7 @@ end
 --- Return elements offset for correct posing nodes. Correct posing at
 -- parent pivot node (0:0) with adjusting of node sizes and anchoring
 -- @treturn vector3 The offset vector
--- @local
+---@private
 function M:_get_zero_offset()
 	if not self.style.IS_DYNAMIC_NODE_POSES then
 		return const.VECTOR_ZERO
@@ -577,7 +577,7 @@ end
 
 --- Return offset x for last row in grid. Used to align this row accorting to grid's anchor
 -- @treturn number The offset x value
--- @local
+---@private
 function M:_get_zero_offset_x(row_index)
 	if not self.style.IS_DYNAMIC_NODE_POSES or not self.style.IS_ALIGN_LAST_ROW then
 		return self._zero_offset.x

druid/base/text.lua

@@ -36,13 +36,13 @@
 -- @alias druid.text
 
 --- On set text callback(self, text)
--- @tfield DruidEvent on_set_text DruidEvent
+-- @tfield druid.event on_set_text druid.event
 
 --- On adjust text size callback(self, new_scale, text_metrics)
--- @tfield DruidEvent on_update_text_scale DruidEvent
+-- @tfield druid.event on_update_text_scale druid.event
 
 --- On change pivot callback(self, pivot)
--- @tfield DruidEvent on_set_pivot DruidEvent
+-- @tfield druid.event on_set_pivot druid.event
 
 --- Text node
 -- @tfield node node

druid/custom/rich_text/module/rt.lua

@@ -2,10 +2,6 @@
 -- Author: Britzl
 -- Modified by: Insality
 
---- RT
--- @module rich_text.rt
--- @local
-
 local helper = require("druid.helper")
 local parser = require("druid.custom.rich_text.module.rt_parse")
 local utf8_lua = require("druid.system.utf8")