Annotations update [2]

druid/extended/checkbox.lua

@@ -71,9 +71,9 @@ end
 
 --- Set checkbox state
 -- @tparam Checkbox self @{Checkbox}
--- @tparam boolean state Checkbox state
--- @tparam boolean is_silent Don't trigger on_change_state if true
--- @tparam boolean is_instant If instant checkbox change
+-- @tparam boolean|nil state Checkbox state
+-- @tparam boolean|nil is_silent Don't trigger on_change_state if true
+-- @tparam boolean|nil is_instant If instant checkbox change
 function Checkbox.set_state(self, state, is_silent, is_instant)
 	self.state = state
 	self.style.on_change_state(self, self.node, state, is_instant)

druid/extended/checkbox_group.lua

@@ -46,7 +46,7 @@ end
 --- Set checkbox group state
 -- @tparam CheckboxGroup self @{CheckboxGroup}
 -- @tparam boolean[] indexes Array of checkbox state
--- @tparam boolean is_instant If instant state change
+-- @tparam boolean|nil is_instant If instant state change
 function CheckboxGroup.set_state(self, indexes, is_instant)
 	for i = 1, #indexes do
 		if self.checkboxes[i] then

druid/extended/dynamic_grid.lua

@@ -100,7 +100,7 @@ end
 -- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam number index The grid element index
 -- @tparam node node The node to be placed
--- @tparam[opt] number origin_index Index of nearby node
+-- @tparam number|nil origin_index Index of nearby node
 -- @treturn vector3 Node position
 function DynamicGrid.get_pos(self, index, node, origin_index)
 	local origin_node = self.nodes[origin_index]
@@ -140,7 +140,7 @@ end
 --- Add new node to the grid
 -- @tparam DynamicGrid self @{DynamicGrid}
 -- @tparam node node Gui node
--- @tparam[opt] number index The node position. By default add as last node
+-- @tparam number|nil index The node position. By default add as last node
 -- @tparam[opt=SHIFT.RIGHT] number shift_policy How shift nodes, if required. See const.SHIFT
 -- @tparam[opt=false] boolean is_instant If true, update node positions instantly
 function DynamicGrid.add(self, node, index, shift_policy, is_instant)
@@ -322,7 +322,7 @@ end
 
 --- Update grid inner state
 -- @tparam DynamicGrid self @{DynamicGrid}
--- @tparam boolean is_instant If true, node position update instantly, otherwise with set_position_function callback
+-- @tparam boolean|nil is_instant If true, node position update instantly, otherwise with set_position_function callback
 -- @local
 function DynamicGrid._update(self, is_instant)
 	self:_update_indexes()
@@ -378,7 +378,7 @@ end
 
 --- Update grid nodes position
 -- @tparam DynamicGrid self @{DynamicGrid}
--- @tparam boolean is_instant If true, node position update instantly, otherwise with set_position_function callback
+-- @tparam boolean|nil is_instant If true, node position update instantly, otherwise with set_position_function callback
 -- @local
 function DynamicGrid._update_pos(self, is_instant)
 	for index, node in pairs(self.nodes) do

druid/extended/hotkey.lua

@@ -31,7 +31,7 @@ local Hotkey = component.create("hotkey")
 -- @tparam Hotkey self @{Hotkey}
 -- @tparam string[]|string keys The keys to be pressed for trigger callback. Should contains one key and any modificator keys
 -- @tparam function callback The callback function
--- @tparam[opt] any callback_argument The argument to pass into the callback function
+-- @tparam any|nil callback_argument The argument to pass into the callback function
 function Hotkey.init(self, keys, callback, callback_argument)
 	self.druid = self:get_druid()
 
@@ -63,7 +63,7 @@ end
 --- Add hotkey for component callback
 -- @tparam Hotkey self @{Hotkey}
 -- @tparam string[]|hash[]|string|hash keys that have to be pressed before key pressed to activate
--- @tparam[opt] any callback_argument The argument to pass into the callback function
+-- @tparam any|nil callback_argument The argument to pass into the callback function
 function Hotkey.add_hotkey(self, keys, callback_argument)
 	keys = keys or {}
 	if type(keys) == "string" then

druid/extended/input.lua

@@ -119,7 +119,7 @@ end
 -- @tparam Input self @{Input}
 -- @tparam node click_node Node to enabled input component
 -- @tparam node|Text text_node Text node what will be changed on user input. You can pass text component instead of text node name @{Text}
--- @tparam[opt] number keyboard_type Gui keyboard type for input field
+-- @tparam number|nil keyboard_type Gui keyboard type for input field
 function Input.init(self, click_node, text_node, keyboard_type)
 	self.druid = self:get_druid(self)
 

druid/extended/lang_text.lua

@@ -34,8 +34,8 @@ local LangText = component.create("lang_text")
 
 --- The @{LangText} constructor
 -- @tparam LangText self @{LangText}
--- @tparam string|node node Node name or GUI Text Node itself
--- @tparam string locale_id Default locale id or text from node as default
+-- @tparam string|node node The node_id or gui.get_node(node_id)
+-- @tparam[opt=node_text] string locale_id Default locale id or text from node as default
 -- @tparam[opt=downscale] string adjust_type Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference
 function LangText.init(self, node, locale_id, adjust_type)
 	self.druid = self:get_druid()
@@ -75,13 +75,13 @@ end
 --- Translate the text by locale_id
 -- @tparam LangText self @{LangText}
 -- @tparam string locale_id Locale id
--- @tparam[opt] string a Optional param to string.format
--- @tparam[opt] string b Optional param to string.format
--- @tparam[opt] string c Optional param to string.format
--- @tparam[opt] string d Optional param to string.format
--- @tparam[opt] string e Optional param to string.format
--- @tparam[opt] string f Optional param to string.format
--- @tparam[opt] string g Optional param to string.format
+-- @tparam string|nil a Optional param to string.format
+-- @tparam string|nil b Optional param to string.format
+-- @tparam string|nil c Optional param to string.format
+-- @tparam string|nil d Optional param to string.format
+-- @tparam string|nil e Optional param to string.format
+-- @tparam string|nil f Optional param to string.format
+-- @tparam string|nil g Optional param to string.format
 -- @treturn LangText Current instance
 function LangText.translate(self, locale_id, a, b, c, d, e, f, g)
 	self.last_locale_args = { a, b, c, d, e, f, g }
@@ -94,13 +94,13 @@ end
 
 --- Format string with new text params on localized text
 -- @tparam LangText self @{LangText}
--- @tparam[opt] string a Optional param to string.format
--- @tparam[opt] string b Optional param to string.format
--- @tparam[opt] string c Optional param to string.format
--- @tparam[opt] string d Optional param to string.format
--- @tparam[opt] string e Optional param to string.format
--- @tparam[opt] string f Optional param to string.format
--- @tparam[opt] string g Optional param to string.format
+-- @tparam string|nil a Optional param to string.format
+-- @tparam string|nil b Optional param to string.format
+-- @tparam string|nil c Optional param to string.format
+-- @tparam string|nil d Optional param to string.format
+-- @tparam string|nil e Optional param to string.format
+-- @tparam string|nil f Optional param to string.format
+-- @tparam string|nil g Optional param to string.format
 -- @treturn LangText Current instance
 function LangText.format(self, a, b, c, d, e, f, g)
 	self.last_locale_args = { a, b, c, d, e, f, g }

druid/extended/layout.lua

@@ -32,7 +32,7 @@ local Layout = component.create("layout")
 -- @tparam Layout self @{Layout}
 -- @tparam node node Gui node
 -- @tparam string mode The layout mode (from const.LAYOUT_MODE)
--- @tparam[opt] function on_size_changed_callback The callback on window resize
+-- @tparam function|nil on_size_changed_callback The callback on window resize
 function Layout.init(self, node, mode, on_size_changed_callback)
 	self.node = self:get_node(node)
 
@@ -194,7 +194,7 @@ end
 
 --- Set node for layout node to fit inside it. Pass nil to reset
 -- @tparam Layout self @{Layout}
--- @tparam[opt] node node
+-- @tparam node|nil node
 -- @treturn Layout @{Layout}
 function Layout.fit_into_node(self, node)
 	self._fit_node = node

druid/extended/progress.lua

@@ -210,7 +210,7 @@ end
 --- Start animation of a progress bar
 -- @tparam Progress self @{Progress}
 -- @tparam number to value between 0..1
--- @tparam[opt] function callback Callback on animation ends
+-- @tparam function|nil callback Callback on animation ends
 function Progress.to(self, to, callback)
 	to = helper.clamp(to, 0, 1)
 	-- cause of float error

druid/extended/radio_group.lua

@@ -55,7 +55,7 @@ end
 --- Set radio group state
 -- @tparam RadioGroup self @{RadioGroup}
 -- @tparam number index Index in radio group
--- @tparam boolean is_instant If is instant state change
+-- @tparam boolean|nil is_instant If is instant state change
 function RadioGroup.set_state(self, index, is_instant)
 	on_checkbox_click(self, index, is_instant)
 end

druid/extended/slider.lua

@@ -60,7 +60,7 @@ end
 -- @tparam Slider self @{Slider}
 -- @tparam node node Gui pin node
 -- @tparam vector3 end_pos The end position of slider
--- @tparam[opt] function callback On slider change callback
+-- @tparam function|nil callback On slider change callback
 function Slider.init(self, node, end_pos, callback)
 	self.node = self:get_node(node)
 
@@ -174,7 +174,7 @@ end
 --- Set value for slider
 -- @tparam Slider self @{Slider}
 -- @tparam number value Value from 0 to 1
--- @tparam[opt] boolean is_silent Don't trigger event if true
+-- @tparam boolean|nil is_silent Don't trigger event if true
 function Slider.set(self, value, is_silent)
 	value = helper.clamp(value, 0, 1)
 	set_position(self, value)

druid/extended/swipe.lua

@@ -13,7 +13,7 @@
 -- @tparam node node
 
 --- Restriction zone
--- @tparam[opt] node click_zone
+-- @tparam node|nil click_zone
 
 --- Trigger on swipe event(self, swipe_side, dist, delta_time)
 -- @tfield DruidEvent on_swipe) @{DruidEvent}

druid/extended/timer.lua

@@ -49,7 +49,7 @@ end
 -- @tparam node node Gui text node
 -- @tparam number seconds_from Start timer value in seconds
 -- @tparam[opt=0] number seconds_to End timer value in seconds
--- @tparam[opt] function callback Function on timer end
+-- @tparam function|nil callback Function on timer end
 function Timer.init(self, node, seconds_from, seconds_to, callback)
 	self.node = self:get_node(node)
 	seconds_from = math.max(seconds_from, 0)
@@ -110,7 +110,7 @@ end
 
 --- Called when update
 -- @tparam Timer self @{Timer}
--- @tparam boolean is_on Timer enable state
+-- @tparam boolean|nil is_on Timer enable state
 function Timer.set_state(self, is_on)
 	self.is_on = is_on