Clean up todo, more docs

druid/base/button.lua

@@ -13,7 +13,7 @@
 -- @table Fields
 -- @tfield node node Trigger node
 -- @tfield[opt=node] node anim_node Animation node
--- @tfield vector3 scale_from Initial scale of anim_node
+-- @tfield vector3 start_scale Initial scale of anim_node
 -- @tfield vector3 pos Initial pos of anim_node
 -- @tfield any params Params to click callbacks
 -- @tfield druid.hover hover Druid hover logic component
@@ -152,8 +152,7 @@ function M.init(self, node, callback, params, anim_node, event)
 	self.node = self:get_node(node)
 
 	self.anim_node = anim_node and helper:get_node(anim_node) or self.node
-	-- TODO: rename to start_scale
-	self.scale_from = gui.get_scale(self.anim_node)
+	self.start_scale = gui.get_scale(self.anim_node)
 	self.params = params
 	self.hover = self.druid:new_hover(node, on_button_hover)
 	self.click_zone = nil

druid/base/timer.lua

@@ -12,12 +12,9 @@
 --- Component fields
 -- @table Fields
 -- @tfield node node Trigger node
--- @tfield[opt=node] node anim_node Animation node
--- @tfield vector3 scale_from Initial scale of anim_node
--- @tfield vector3 pos Initial pos of anim_node
--- @tfield any params Params to click callbacks
--- @tfield druid.hover hover Druid hover logic component
--- @tfield[opt] node click_zone Restriction zone
+-- @tfield number from Initial timer value
+-- @tfield number target Target timer value
+-- @tfield number value Current timer value
 
 local Event = require("druid.event")
 local const = require("druid.const")

druid/component.lua

@@ -86,10 +86,13 @@ function Component.get_interests(self)
 end
 
 
--- TODO: Определиться с get_node и node
--- get_node - берет ноду по ноде или строке
--- node - может брать ноду у компонента по схеме (если есть
--- template или таблица нод после gui.clone_tree)
+--- Get node for component by name.
+-- If component has nodes, node_or_name should be string
+-- It auto pick node by template name or from nodes by clone_tree
+-- if they was setup via component:set_nodes, component:set_template
+-- @function component:get_node
+-- @tparam string|node node_or_name Node name or node itself
+-- @treturn node Gui node
 function Component.get_node(self, node_or_name)
 	local template_name = self:get_template() or const.EMPTY_STRING
 	local nodes = self:get_nodes()

druid/druid.lua

@@ -31,13 +31,10 @@ local M = {}
 -- @tparam table module lua table with component
 function M.register(name, module)
 	-- TODO: Find better solution to creating elements?
-	-- Possibly: druid.new(druid.BUTTON, etc?)
 	-- Current way is very implicit
 	druid_instance["new_" .. name] = function(self, ...)
 		return druid_instance.create(self, module, ...)
 	end
-
-	-- print("Register component", name)
 end
 
 

druid/styles/default/anims.lua

@@ -24,7 +24,7 @@ end
 function M.tap_scale_animation(self, node, target_scale)
 	scale_to(self, node, target_scale,
 		function()
-			M.back_scale_animation(self, node, self.scale_from)
+			M.back_scale_animation(self, node, self.start_scale)
 		end
 	)
 end

druid/styles/default/style.lua

@@ -18,14 +18,14 @@ M["button"] = {
 	IS_HOVER = true,
 
 	on_hover = function(self, node, state)
-		local scale_to = self.scale_from + M.button.HOVER_SCALE
+		local scale_to = self.start_scale + M.button.HOVER_SCALE
 
-		local target_scale = state and scale_to or self.scale_from
+		local target_scale = state and scale_to or self.start_scale
 		anims.hover_scale(self, target_scale, M.button.HOVER_TIME)
 	end,
 
 	on_click = function(self, node)
-		local scale_to = self.scale_from + M.button.SCALE_CHANGE
+		local scale_to = self.start_scale + M.button.SCALE_CHANGE
 		anims.tap_scale_animation(self, node, scale_to)
 		settings.play_sound(M.button.BTN_SOUND)
 	end,