Update annotations

druid/extended/checkbox.lua

@@ -14,7 +14,7 @@
 -- @tfield node node
 
 --- Button trigger node
--- @tfield[opt=node] node click_node
+-- @tfield node|nil click_node
 
 --- Button component from click_node
 -- @tfield Button button @{Button}
@@ -50,8 +50,8 @@ end
 -- @tparam Checkbox self @{Checkbox}
 -- @tparam node node Gui node
 -- @tparam function callback Checkbox callback
--- @tparam[opt=node] node click_node Trigger node, by default equals to node
--- @tparam[opt=false] boolean initial_state The initial state of checkbox, default - false
+-- @tparam node|nil click_node Trigger node, by default equals to node. Default: node
+-- @tparam boolean|nil initial_state The initial state of checkbox, default - false
 function Checkbox.init(self, node, callback, click_node, initial_state)
 	self.druid = self:get_druid()
 	self.node = self:get_node(node)

druid/extended/checkbox_group.lua

@@ -25,7 +25,7 @@ local CheckboxGroup = component.create("checkbox_group")
 -- @tparam CheckboxGroup self @{CheckboxGroup}
 -- @tparam node[] nodes Array of gui node
 -- @tparam function callback Checkbox callback
--- @tparam[opt=node] node[] click_nodes Array of trigger nodes, by default equals to nodes
+-- @tparam node[]|nil click_nodes Array of trigger nodes, by default equals to nodes
 function CheckboxGroup.init(self, nodes, callback, click_nodes)
 	self.druid = self:get_druid()
 	self.checkboxes = {}

druid/extended/dynamic_grid.lua

@@ -101,7 +101,7 @@ end
 -- @tparam number index The grid element index
 -- @tparam node node The node to be placed
 -- @tparam number|nil origin_index Index of nearby node
--- @treturn vector3 Node position
+-- @treturn vector3 node position
 function DynamicGrid.get_pos(self, index, node, origin_index)
 	local origin_node = self.nodes[origin_index]
 

druid/extended/hotkey.lua

@@ -14,7 +14,7 @@
 -- @tfield node node
 
 --- Button trigger node
--- @tfield[opt=node] node click_node
+-- @tfield node|nil click_node
 
 --- Button component from click_node
 -- @tfield Button button @{Button}

druid/extended/input.lua

@@ -87,10 +87,10 @@ end
 -- You can override this component styles params in druid styles table
 -- or create your own style
 -- @table style
--- @tfield[opt=false] boolean IS_LONGTAP_ERASE Is long tap will erase current input data
--- @tfield[opt=*] string MASK_DEFAULT_CHAR Default character mask for password input
--- @tfield[opt=false] boolean IS_UNSELECT_ON_RESELECT If true, call unselect on select selected input
--- @tfield[opt=false] boolean NO_CONSUME_INPUT_WHILE_SELECTED If true, will not consume input while input is selected. It's allow to interact with other components while input is selected (text input still captured)
+-- @tfield boolean IS_LONGTAP_ERASE Is long tap will erase current input data. Default: false
+-- @tfield string MASK_DEFAULT_CHAR Default character mask for password input. Default: *]
+-- @tfield boolean IS_UNSELECT_ON_RESELECT If true, call unselect on select selected input. Default: false
+-- @tfield boolean NO_CONSUME_INPUT_WHILE_SELECTED If true, will not consume input while input is selected. It's allow to interact with other components while input is selected (text input still captured). Default: false
 -- @tfield function on_select (self, button_node) Callback on input field selecting
 -- @tfield function on_unselect (self, button_node) Callback on input field unselecting
 -- @tfield function on_input_wrong (self, button_node) Callback on wrong user input

druid/extended/lang_text.lua

@@ -38,8 +38,8 @@ local LangText = component.create("lang_text")
 --- The @{LangText} constructor
 -- @tparam LangText self @{LangText}
 -- @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
+-- @tparam string|nil locale_id Default locale id or text from node as default
+-- @tparam string|nil 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()
 	self.text = self.druid:new_text(node, locale_id, adjust_type)

druid/extended/progress.lua

@@ -101,8 +101,8 @@ end
 -- You can override this component styles params in druid styles table
 -- or create your own style
 -- @table style
--- @tfield[opt=5] number SPEED Progress bas fill rate. More -> faster
--- @tfield[opt=0.005] number MIN_DELTA Minimum step to fill progress bar
+-- @tfield number|nil SPEED Progress bas fill rate. More -> faster. Default: 5
+-- @tfield number|nil MIN_DELTA Minimum step to fill progress bar. Default: 0.005
 function Progress.on_style_change(self, style)
 	self.style = {}
 	self.style.SPEED = style.SPEED or 5
@@ -114,7 +114,7 @@ end
 -- @tparam Progress self @{Progress}
 -- @tparam string|node node Node name or GUI Node itself.
 -- @tparam string key Progress bar direction: const.SIDE.X or const.SIDE.Y
--- @tparam[opt=1] number init_value Initial value of progress bar
+-- @tparam number|nil init_value Initial value of progress bar. Default: 1
 function Progress.init(self, node, key, init_value)
 	assert(key == const.SIDE.X or const.SIDE.Y, "Progress bar key should be 'x' or 'y'")
 

druid/extended/radio_group.lua

@@ -34,7 +34,7 @@ end
 -- @tparam RadioGroup self @{RadioGroup}
 -- @tparam node[] nodes Array of gui node
 -- @tparam function callback Radio callback
--- @tparam[opt=node] node[] click_nodes Array of trigger nodes, by default equals to nodes
+-- @tparam node[]|nil click_nodes Array of trigger nodes, by default equals to nodes. Default - nodes
 function RadioGroup.init(self, nodes, callback, click_nodes)
 	self.druid = self:get_druid()
 	self.checkboxes = {}

druid/extended/slider.lua

@@ -202,7 +202,7 @@ end
 -- move at this position and node drag will start.
 -- This function require the Defold version 1.3.0+
 -- @tparam Slider self @{Slider}
--- @tparam node input_node
+-- @tparam node|string|nil input_node
 -- @treturn Slider @{Slider}
 function Slider.set_input_node(self, input_node)
 	self._input_node = self:get_node(input_node)

druid/extended/swipe.lua

@@ -74,9 +74,9 @@ end
 -- You can override this component styles params in druid styles table
 -- or create your own style
 -- @table style
--- @tfield[opt=0.4] number SWIPE_TIME Maximum time for swipe trigger
--- @tfield[opt=50] number SWIPE_THRESHOLD Minimum distance for swipe trigger
--- @tfield[opt=false] boolean SWIPE_TRIGGER_ON_MOVE If true, trigger on swipe moving, not only release action
+-- @tfield number|nil SWIPE_TIME Maximum time for swipe trigger. Default: 0.4
+-- @tfield number|nil SWIPE_THRESHOLD Minimum distance for swipe trigger. Default: 50
+-- @tfield boolean|nil SWIPE_TRIGGER_ON_MOVE If true, trigger on swipe moving, not only release action. Default: false
 function Swipe.on_style_change(self, style)
 	self.style = {}
 	self.style.SWIPE_TIME = style.SWIPE_TIME or 0.4
@@ -150,7 +150,7 @@ end
 --- Strict swipe click area. Useful for
 -- restrict events outside stencil node
 -- @tparam Swipe self @{Swipe}
--- @tparam node zone Gui node
+-- @tparam node|string|nil zone Gui node
 function Swipe.set_click_zone(self, zone)
 	self.click_zone = self:get_node(zone)
 end