Partydeck/Extension-Druid
3
0
Fork 0
mirror of https://github.com/Insality/druid.git synced 2025-06-27 10:27:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add protected field to annotations

Browse Source
This commit is contained in:
Insality 2022-03-08 22:06:39 +02:00
parent 2e9ab69001
commit 6e2fe4de83
2 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
config.ld
View File

@ -4,7 +4,8 @@ description='Documentation for Druid Library'
file={"./druid", file={"./druid",
exclude = { exclude = {
"./druid/styles/", "./druid/styles/",
"./druid/system/middleclass.lua" "./druid/system/middleclass.lua",
"./druid/templates/"
} }
} }
package='druid' package='druid'
@ -13,4 +14,4 @@ dir='./docs'
style='!fixed' style='!fixed'
topics={} topics={}
use_markdown_titles=true use_markdown_titles=true
no_space_before_args=true no_space_before_args=true

18
druid/component.lua
View File

@ -55,7 +55,7 @@ function BaseComponent.static.get_uid()
end end
--- Set current component style table. --- Set current component style table (protected).
-- Invoke `on_style_change` on component, if exist. BaseComponent should handle -- Invoke `on_style_change` on component, if exist. BaseComponent should handle
-- their style changing and store all style params -- their style changing and store all style params
-- @tparam BaseComponent self -- @tparam BaseComponent self
@ -70,7 +70,7 @@ function BaseComponent.set_style(self, druid_style)
end end
--- Set current component template name --- Set current component template name (protected)
-- @tparam BaseComponent self -- @tparam BaseComponent self
-- @tparam string template BaseComponent template name -- @tparam string template BaseComponent template name
function BaseComponent.set_template(self, template) function BaseComponent.set_template(self, template)
@ -78,7 +78,7 @@ function BaseComponent.set_template(self, template)
end end
--- Set current component nodes --- Set current component nodes (protected)
-- @tparam BaseComponent self -- @tparam BaseComponent self
-- @tparam table nodes BaseComponent nodes table -- @tparam table nodes BaseComponent nodes table
function BaseComponent.set_nodes(self, nodes) function BaseComponent.set_nodes(self, nodes)
@ -86,7 +86,7 @@ function BaseComponent.set_nodes(self, nodes)
end end
--- Get current component context --- Get current component context (protected)
-- @tparam BaseComponent self -- @tparam BaseComponent self
-- @treturn table BaseComponent context -- @treturn table BaseComponent context
function BaseComponent.get_context(self) function BaseComponent.get_context(self)
@ -133,7 +133,7 @@ function BaseComponent.get_node(self, node_or_name)
end end
--- Return druid with context of calling component. --- Return druid with context of calling component (protected).
-- Use it to create component inside of other components. -- Use it to create component inside of other components.
-- @tparam BaseComponent self -- @tparam BaseComponent self
-- @treturn Druid Druid instance with component context -- @treturn Druid Druid instance with component context
@ -189,7 +189,8 @@ function BaseComponent.reset_input_priority(self)
end end
--- Return component uid. UID generated in component creation order --- Return component uid (protected).
--- UID generated in component creation order
-- @tparam BaseComponent self -- @tparam BaseComponent self
-- @treturn number The component uid -- @treturn number The component uid
function BaseComponent.get_uid(self) function BaseComponent.get_uid(self)
@ -213,7 +214,7 @@ function BaseComponent.set_input_enabled(self, state)
end end
--- Return the parent for current component --- Return the parent for current component (protected)
-- @tparam BaseComponent self -- @tparam BaseComponent self
-- @treturn BaseComponent|nil The druid component instance or nil -- @treturn BaseComponent|nil The druid component instance or nil
function BaseComponent.get_parent_component(self) function BaseComponent.get_parent_component(self)
@ -233,6 +234,7 @@ end
-- @tparam table context Druid context. Usually it is self of script -- @tparam table context Druid context. Usually it is self of script
-- @tparam table style Druid style module -- @tparam table style Druid style module
-- @treturn component BaseComponent itself -- @treturn component BaseComponent itself
-- @local
function BaseComponent.setup_component(self, druid_instance, context, style) function BaseComponent.setup_component(self, druid_instance, context, style)
self._meta = { self._meta = {
template = nil, template = nil,
@ -360,7 +362,7 @@ function BaseComponent.__remove_children(self, children)
end end
--- Return all children components, recursive --- Return all children components, recursive (protected)
-- @tparam BaseComponent self -- @tparam BaseComponent self
-- @treturn table Array of childrens if the Druid component instance -- @treturn table Array of childrens if the Druid component instance
function BaseComponent.get_childrens(self) function BaseComponent.get_childrens(self)