Correct the name of get_children's return value (#2927)

get_children's return value should not be called "The". That was a
mistake because ldoc requires a name for return values and parameters.
If a name isn't provided, it thinks the first word of the description
is the name.
This commit is contained in:
Jordan Christiansen 2019-11-25 16:04:01 -06:00 committed by Emmanuel Lepage Vallée
parent f8a9c59d50
commit c09e5b16b7
3 changed files with 5 additions and 5 deletions

View File

@ -10,14 +10,14 @@
--- Get or set the children elements. --- Get or set the children elements.
-- @property children -- @property children
-- @tparam table The children -- @tparam table children The children.
--- Get all direct and indirect children widgets. --- Get all direct and indirect children widgets.
-- This will scan all containers recursively to find widgets -- This will scan all containers recursively to find widgets
-- Warning: This method it prone to stack overflow id the widget, or any of its -- Warning: This method it prone to stack overflow id the widget, or any of its
-- children, contain (directly or indirectly) itself. -- children, contain (directly or indirectly) itself.
-- @property all_children -- @property all_children
-- @tparam table The children -- @tparam table children The children.
--- Set a declarative widget hierarchy description. --- Set a declarative widget hierarchy description.
-- See [The declarative layout system](../documentation/03-declarative-layout.md.html) -- See [The declarative layout system](../documentation/03-declarative-layout.md.html)

View File

@ -73,7 +73,7 @@ end
--- Get or set the children elements. --- Get or set the children elements.
-- @property children -- @property children
-- @tparam table The children -- @tparam table children The children.
function place:get_children() function place:get_children()
return {self._private.widget} return {self._private.widget}

View File

@ -140,7 +140,7 @@ end
--- Get the widget's direct children widgets. --- Get the widget's direct children widgets.
-- --
-- This method should be re-implemented by the relevant widgets. -- This method should be re-implemented by the relevant widgets.
-- @treturn table The children -- @treturn table children The children.
-- @method get_children -- @method get_children
function base.widget:get_children() function base.widget:get_children()
return {} return {}
@ -170,7 +170,7 @@ end
-- --
-- *Warning*: This method it prone to stack overflow if the widget, or any of -- *Warning*: This method it prone to stack overflow if the widget, or any of
-- its children, contains (directly or indirectly) itself. -- its children, contains (directly or indirectly) itself.
-- @treturn table The children -- @treturn table children The children.
-- @method get_all_children -- @method get_all_children
function base.widget:get_all_children() function base.widget:get_all_children()
local ret = {} local ret = {}