Update ldoc code comments

This commit is contained in:
Insality
2020-02-05 02:44:09 +03:00
parent 92098052e3
commit 544fd8d736
18 changed files with 98 additions and 20 deletions

View File

@@ -1,5 +1,5 @@
--- Component to handle back key (android, backspace)
-- @module base.back_handler
-- @module druid.back_handler
local const = require("druid.const")
local component = require("druid.system.component")

View File

@@ -1,5 +1,5 @@
--- Component to block input on specify zone (node)
-- @module base.blocker
-- @module druid.blocker
local const = require("druid.const")
local helper = require("druid.helper")

View File

@@ -1,5 +1,5 @@
--- Component to handle basic GUI button
-- @module base.button
-- @module druid.button
-- TODO: Add button mode:
-- Long tap
@@ -26,8 +26,10 @@ function M.init(self, node, callback, params, anim_node, event)
self.style = self:get_style()
self.node = helper.get_node(node)
-- TODO: match event inside on_input?
self.event = const.ACTION_TOUCH
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.pos = gui.get_position(self.anim_node)
self.callback = callback

View File

@@ -1,5 +1,5 @@
--- Druid checkbox component
-- @module base.checkbox
-- @module druid.checkbox
local helper = require("druid.helper")
local component = require("druid.system.component")

View File

@@ -1,5 +1,5 @@
--- Checkboux group module
-- @module base.checkbox_group
-- @module druid.checkbox_group
local component = require("druid.system.component")

View File

@@ -1,6 +1,6 @@
--- Component to handle placing components by row and columns.
-- Grid can anchor your elements, get content size and other
-- @module base.grid
-- @module druid.grid
local helper = require("druid.helper")
local component = require("druid.system.component")

View File

@@ -1,6 +1,6 @@
--- Component to handle all GUI texts
-- Good working with localization system
-- @module base.text
-- @module druid.locale
local const = require("druid.const")
local settings = require("druid.system.settings")

View File

@@ -1,5 +1,5 @@
--- Basic progress bar component
-- @module base.progress
-- @module druid.progress
local const = require("druid.const")
local helper = require("druid.helper")

View File

@@ -1,5 +1,5 @@
--- Radio group module
-- @module base.checkbox_group
-- @module druid.radio_group
local component = require("druid.system.component")

View File

@@ -1,5 +1,5 @@
--- Component to handle scroll content
-- @module base.scroll
-- @module druid.scroll
local helper = require("druid.helper")
local const = require("druid.const")

View File

@@ -1,5 +1,5 @@
--- Druid slider component
-- @module base.slider
-- @module druid.slider
local helper = require("druid.helper")
local const = require("druid.const")

View File

@@ -1,6 +1,6 @@
--- Component to handle all GUI texts
-- Good working with localization system
-- @module base.text
-- @module druid.text
local const = require("druid.const")
local helper = require("druid.helper")

View File

@@ -1,5 +1,5 @@
--- Component to handle GUI timers
-- @module base.timer
-- @module druid.timer
local const = require("druid.const")
local formats = require("druid.helper.formats")