Annotations update

druid/helper.lua

@@ -255,9 +255,9 @@ end
 
 --- Add all elements from source array to the target array
 -- @function helper.add_array
--- @tparam table target Array to put elements from source
--- @tparam[opt] table source The source array to get elements from
--- @treturn array The target array
+-- @tparam any[] target Array to put elements from source
+-- @tparam[opt] any[] source The source array to get elements from
+-- @treturn any[] The target array
 function M.add_array(target, source)
 	assert(target)
 
@@ -275,7 +275,7 @@ end
 
 --- Make a check with gui.pick_node, but with additional node_click_area check.
 -- @function helper.pick_node
--- @tparam Node node
+-- @tparam node node
 -- @tparam number x
 -- @tparam number y
 -- @tparam[opt] Node node_click_area
@@ -302,7 +302,7 @@ end
 --- Get cumulative parent's node scale
 -- @function helper.get_scene_scale
 -- @tparam node node Gui node
--- @tparam bool include_passed_node_scale True if add current node scale to result
+-- @tparam boolean include_passed_node_scale True if add current node scale to result
 -- @treturn vector3 The scene node scale
 function M.get_scene_scale(node, include_passed_node_scale)
 	local scale = include_passed_node_scale and gui.get_scale(node) or vmath.vector3(1)
@@ -345,7 +345,7 @@ end
 --
 -- Offset shown in [-0.5 .. 0.5] range, where -0.5 is left or bottom, 0.5 is right or top.
 -- @function helper.get_pivot_offset
--- @tparam gui.pivot pivot The node pivot
+-- @tparam number pivot The gui.PIVOT_* constant
 -- @treturn vector3 Vector offset with [-0.5..0.5] values
 function M.get_pivot_offset(pivot)
 	return const.PIVOTS[pivot]
@@ -354,7 +354,7 @@ end
 
 --- Check if device is native mobile (Android or iOS)
 -- @function helper.is_mobile
--- @treturn bool Is mobile
+-- @treturn boolean Is mobile
 function M.is_mobile()
 	return const.CURRENT_SYSTEM_NAME == const.OS.IOS or
 			 const.CURRENT_SYSTEM_NAME == const.OS.ANDROID
@@ -363,7 +363,7 @@ end
 
 --- Check if device is HTML5
 -- @function helper.is_web
--- @treturn bool Is web
+-- @treturn boolean Is web
 function M.is_web()
 	return const.CURRENT_SYSTEM_NAME == const.OS.BROWSER
 end
@@ -420,7 +420,7 @@ end
 
 --- Get text metric from GUI node.
 -- @function helper.get_text_metrics_from_node
--- @tparam Node text_node
+-- @tparam node text_node
 -- @treturn GUITextMetrics
 -- @usage
 -- type GUITextMetrics = {
@@ -451,10 +451,10 @@ end
 -- Shift policy can be: left, right, no_shift
 -- @function helper.insert_with_shift
 -- @tparam table array Array
--- @param item Item to insert
+-- @param any Item to insert
 -- @tparam[opt] number index Index to insert. If nil, item will be inserted at the end of array
--- @tparam[opt] const.SHIFT shift_policy Shift policy
--- @treturn item Inserted item
+-- @tparam[opt] number shift_policy The druid_const.SHIFT.* constant
+-- @treturn any Inserted item
 function M.insert_with_shift(array, item, index, shift_policy)
 	shift_policy = shift_policy or const.SHIFT.RIGHT
 
@@ -484,8 +484,8 @@ end
 -- @function helper.remove_with_shift
 -- @tparam table array Array
 -- @tparam[opt] number index Index to remove. If nil, item will be removed from the end of array
--- @tparam[opt] const.SHIFT shift_policy Shift policy
--- @treturn item Removed item
+-- @tparam[opt] number shift_policy The druid_const.SHIFT.* constant
+-- @treturn any Removed item
 function M.remove_with_shift(array, index, shift_policy)
 	shift_policy = shift_policy or const.SHIFT.RIGHT