doc(@supermodule): Add to wibox.container modules

This commit is contained in:
Aire-One 2021-03-27 20:05:10 +01:00
parent 3ed2fc8500
commit 3b12a8d19a
9 changed files with 9 additions and 36 deletions

View File

@ -8,6 +8,7 @@
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
-- @copyright 2013 Emmanuel Lepage Vallee -- @copyright 2013 Emmanuel Lepage Vallee
-- @containermod wibox.container.arcchart -- @containermod wibox.container.arcchart
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -357,10 +358,6 @@ function arcchart.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(arcchart, arcchart.mt) return setmetatable(arcchart, arcchart.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -6,6 +6,7 @@
-- @author Uli Schlachter -- @author Uli Schlachter
-- @copyright 2010 Uli Schlachter -- @copyright 2010 Uli Schlachter
-- @containermod wibox.container.background -- @containermod wibox.container.background
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local base = require("wibox.widget.base") local base = require("wibox.widget.base")
@ -484,10 +485,6 @@ function background.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(background, background.mt) return setmetatable(background, background.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -5,6 +5,7 @@
-- @author Lukáš Hrázký -- @author Lukáš Hrázký
-- @copyright 2012 Lukáš Hrázký -- @copyright 2012 Lukáš Hrázký
-- @containermod wibox.container.constraint -- @containermod wibox.container.constraint
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -176,10 +177,6 @@ function constraint.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(constraint, constraint.mt) return setmetatable(constraint, constraint.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -5,6 +5,7 @@
-- @author Uli Schlachter -- @author Uli Schlachter
-- @copyright 2010 Uli Schlachter -- @copyright 2010 Uli Schlachter
-- @containermod wibox.container.margin -- @containermod wibox.container.margin
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local pairs = pairs local pairs = pairs
@ -238,10 +239,6 @@ function margin.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(margin, margin.mt) return setmetatable(margin, margin.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -5,6 +5,7 @@
-- @author dodo -- @author dodo
-- @copyright 2012 dodo -- @copyright 2012 dodo
-- @containermod wibox.container.mirror -- @containermod wibox.container.mirror
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local type = type local type = type
@ -129,10 +130,6 @@ function mirror.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(mirror, mirror.mt) return setmetatable(mirror, mirror.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -5,6 +5,7 @@
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
-- @copyright 2016 Emmanuel Lepage Vallee -- @copyright 2016 Emmanuel Lepage Vallee
-- @containermod wibox.container.place -- @containermod wibox.container.place
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -203,10 +204,6 @@ function place.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(place, place.mt) return setmetatable(place, place.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -8,6 +8,7 @@
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
-- @copyright 2013 Emmanuel Lepage Vallee -- @copyright 2013 Emmanuel Lepage Vallee
-- @containermod wibox.container.radialprogressbar -- @containermod wibox.container.radialprogressbar
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -281,10 +282,6 @@ function radialprogressbar.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(radialprogressbar, radialprogressbar.mt) return setmetatable(radialprogressbar, radialprogressbar.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -5,6 +5,7 @@
-- @author Uli Schlachter -- @author Uli Schlachter
-- @copyright 2010 Uli Schlachter -- @copyright 2010 Uli Schlachter
-- @containermod wibox.container.rotate -- @containermod wibox.container.rotate
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local error = error local error = error
@ -149,10 +150,6 @@ function rotate.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(rotate, rotate.mt) return setmetatable(rotate, rotate.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -21,6 +21,7 @@
-- @author Uli Schlachter (based on ideas from Saleur Geoffrey) -- @author Uli Schlachter (based on ideas from Saleur Geoffrey)
-- @copyright 2015 Uli Schlachter -- @copyright 2015 Uli Schlachter
-- @containermod wibox.container.scroll -- @containermod wibox.container.scroll
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local cache = require("gears.cache") local cache = require("gears.cache")
@ -549,10 +550,6 @@ function scroll.step_functions.waiting_nonlinear_back_and_forth(elapsed, size, v
return (size - visible_size) * state return (size - visible_size) * state
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return scroll return scroll
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80