doc(@supermodule): Add to awful.widget modules

This commit is contained in:
Aire-One 2021-03-27 20:05:10 +01:00
parent 3969ad8819
commit 20a8d902c5
7 changed files with 9 additions and 24 deletions

View File

@ -6,6 +6,7 @@
-- @author Julien Danjou <julien@danjou.info> -- @author Julien Danjou <julien@danjou.info>
-- @copyright 2008-2009 Julien Danjou -- @copyright 2008-2009 Julien Danjou
-- @widgetmod awful.widget.button -- @widgetmod awful.widget.button
-- @supermodule wibox.widget.imagebox
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -65,10 +66,6 @@ function button.mt:__call(...)
return button.new(...) return button.new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(button, button.mt) return setmetatable(button, button.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

@ -1,7 +1,10 @@
---------------------------------------------------------------------------
--- Container showing the icon of a client. --- Container showing the icon of a client.
-- @author Uli Schlachter -- @author Uli Schlachter
-- @copyright 2017 Uli Schlachter -- @copyright 2017 Uli Schlachter
-- @widgetmod awful.widget.clienticon -- @widgetmod awful.widget.clienticon
-- @supermodule wibox.widget.base
---------------------------------------------------------------------------
local base = require("wibox.widget.base") local base = require("wibox.widget.base")
local surface = require("gears.surface") local surface = require("gears.surface")
@ -123,10 +126,6 @@ client.connect_signal("property::icon", function(c)
end end
end) end)
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(clienticon, { return setmetatable(clienticon, {
__call = function(_, ...) __call = function(_, ...)
return new(...) return new(...)

View File

@ -11,6 +11,7 @@
-- @author Julien Danjou <julien@danjou.info> -- @author Julien Danjou <julien@danjou.info>
-- @copyright 2008-2009 Julien Danjou -- @copyright 2008-2009 Julien Danjou
-- @widgetmod awful.widget.launcher -- @widgetmod awful.widget.launcher
-- @supermodule awful.widget.button
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -50,10 +51,6 @@ function launcher.mt:__call(...)
return launcher.new(...) return launcher.new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(launcher, launcher.mt) return setmetatable(launcher, launcher.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 Julien Danjou <julien@danjou.info> -- @author Julien Danjou <julien@danjou.info>
-- @copyright 2009 Julien Danjou -- @copyright 2009 Julien Danjou
-- @widgetmod awful.widget.layoutbox -- @widgetmod awful.widget.layoutbox
-- @supermodule wibox.layout.fixed
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable

View File

@ -21,6 +21,7 @@
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
-- @copyright 2010, 2018 Emmanuel Lepage Vallee -- @copyright 2010, 2018 Emmanuel Lepage Vallee
-- @widgetmod awful.widget.layoutlist -- @widgetmod awful.widget.layoutlist
-- @supermodule wibox.widget.base
---------------------------------------------------------------------------- ----------------------------------------------------------------------------
local capi = {screen = screen, tag = tag} local capi = {screen = screen, tag = tag}
@ -444,8 +445,4 @@ local function new(_, args)
return ret return ret
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(module, {__call = new}) return setmetatable(module, {__call = new})

View File

@ -5,6 +5,7 @@
-- @author Uli Schlachter -- @author Uli Schlachter
-- @copyright 2017 Uli Schlachter -- @copyright 2017 Uli Schlachter
-- @containermod awful.widget.only_on_screen -- @containermod awful.widget.only_on_screen
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local type = type local type = type
@ -129,10 +130,6 @@ capi.screen.connect_signal("property::outputs", function()
end end
end) end)
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(only_on_screen, only_on_screen.mt) return setmetatable(only_on_screen, only_on_screen.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

@ -7,6 +7,7 @@
-- @copyright 2009 Julien Danjou -- @copyright 2009 Julien Danjou
-- @copyright 2018 Aire-One -- @copyright 2018 Aire-One
-- @widgetmod awful.widget.prompt -- @widgetmod awful.widget.prompt
-- @supermodule wibox.container.background
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
--- The prompt foreground color. --- The prompt foreground color.
@ -158,10 +159,6 @@ function widgetprompt.mt:__call(...)
return widgetprompt.new(...) return widgetprompt.new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(widgetprompt, widgetprompt.mt) return setmetatable(widgetprompt, widgetprompt.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