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

This commit is contained in:
Aire-One 2021-03-27 20:41:28 +01:00
parent 5baa1c97cd
commit 3ed2fc8500
10 changed files with 11 additions and 40 deletions

View File

@ -9,6 +9,7 @@
-- @author Emmanuel Lepage Valle -- @author Emmanuel Lepage Valle
-- @copyright 2010 Emmanuel Lepage Vallee -- @copyright 2010 Emmanuel Lepage Vallee
-- @widgetmod wibox.widget.checkbox -- @widgetmod wibox.widget.checkbox
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local color = require( "gears.color" ) local color = require( "gears.color" )
@ -303,10 +304,6 @@ local function new(checked, args)
return ret return ret
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable({}, { __call = function(_, ...) return new(...) end}) return setmetatable({}, { __call = function(_, ...) return new(...) end})
-- 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

@ -14,6 +14,7 @@
-- @author Julien Danjou <julien@danjou.info> -- @author Julien Danjou <julien@danjou.info>
-- @copyright 2009 Julien Danjou -- @copyright 2009 Julien Danjou
-- @widgetmod wibox.widget.graph -- @widgetmod wibox.widget.graph
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -413,10 +414,6 @@ function graph.mt:__call(...)
return graph.new(...) return graph.new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(graph, graph.mt) return setmetatable(graph, graph.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 -- @author Uli Schlachter
-- @copyright 2010 Uli Schlachter -- @copyright 2010 Uli Schlachter
-- @widgetmod wibox.widget.imagebox -- @widgetmod wibox.widget.imagebox
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local lgi = require("lgi") local lgi = require("lgi")
@ -290,10 +291,6 @@ function imagebox.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(imagebox, imagebox.mt) return setmetatable(imagebox, imagebox.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 Valle -- @author Emmanuel Lepage Valle
-- @copyright 2012 Emmanuel Lepage Vallee -- @copyright 2012 Emmanuel Lepage Vallee
-- @widgetmod wibox.widget.piechart -- @widgetmod wibox.widget.piechart
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local color = require( "gears.color" ) local color = require( "gears.color" )
@ -260,9 +261,5 @@ local function new(data_list)
return ret return ret
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(module, { __call = function(_, ...) return new(...) end }) return setmetatable(module, { __call = function(_, ...) return new(...) end })
-- 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

@ -18,6 +18,7 @@
-- @author Julien Danjou <julien@danjou.info> -- @author Julien Danjou <julien@danjou.info>
-- @copyright 2009 Julien Danjou -- @copyright 2009 Julien Danjou
-- @widgetmod wibox.widget.progressbar -- @widgetmod wibox.widget.progressbar
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -520,10 +521,6 @@ function progressbar.mt:__call(...)
return progressbar.new(...) return progressbar.new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(progressbar, progressbar.mt) return setmetatable(progressbar, progressbar.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

@ -20,6 +20,7 @@
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
-- @copyright 2014, 2017 Emmanuel Lepage Vallee -- @copyright 2014, 2017 Emmanuel Lepage Vallee
-- @widgetmod wibox.widget.separator -- @widgetmod wibox.widget.separator
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local beautiful = require( "beautiful" ) local beautiful = require( "beautiful" )
local base = require( "wibox.widget.base" ) local base = require( "wibox.widget.base" )
@ -215,9 +216,5 @@ local function new(args)
return ret return ret
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(separator, { __call = function(_, ...) return new(...) end }) return setmetatable(separator, { __call = function(_, ...) return new(...) end })
-- 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 @@
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
-- @copyright 2015 Grigory Mishchenko, 2016 Emmanuel Lepage Vallee -- @copyright 2015 Grigory Mishchenko, 2016 Emmanuel Lepage Vallee
-- @widgetmod wibox.widget.slider -- @widgetmod wibox.widget.slider
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -538,10 +539,6 @@ function slider.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(slider, slider.mt) return setmetatable(slider, slider.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

@ -2,6 +2,7 @@
-- @author Uli Schlachter -- @author Uli Schlachter
-- @copyright 2010 Uli Schlachter -- @copyright 2010 Uli Schlachter
-- @widgetmod wibox.widget.systray -- @widgetmod wibox.widget.systray
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local wbase = require("wibox.widget.base") local wbase = require("wibox.widget.base")
@ -224,10 +225,6 @@ function systray.mt:__call(...)
return instance return instance
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(systray, systray.mt) return setmetatable(systray, systray.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,10 +1,12 @@
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
-- --
--@DOC_wibox_widget_defaults_textbox_EXAMPLE@ --@DOC_wibox_widget_defaults_textbox_EXAMPLE@
--
-- @author Uli Schlachter -- @author Uli Schlachter
-- @author dodo -- @author dodo
-- @copyright 2010, 2011 Uli Schlachter, dodo -- @copyright 2010, 2011 Uli Schlachter, dodo
-- @widgetmod wibox.widget.textbox -- @widgetmod wibox.widget.textbox
-- @supermodule wibox.widget.base
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local base = require("wibox.widget.base") local base = require("wibox.widget.base")
@ -373,10 +375,6 @@ function textbox.mt.__call(_, ...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(textbox, textbox.mt) return setmetatable(textbox, textbox.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

@ -4,6 +4,7 @@
-- @author Julien Danjou <julien@danjou.info> -- @author Julien Danjou <julien@danjou.info>
-- @copyright 2009 Julien Danjou -- @copyright 2009 Julien Danjou
-- @widgetmod wibox.widget.textclock -- @widgetmod wibox.widget.textclock
-- @supermodule wibox.widget.textbox
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local setmetatable = setmetatable local setmetatable = setmetatable
@ -126,10 +127,6 @@ function textclock.mt:__call(...)
return new(...) return new(...)
end end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(textclock, textclock.mt) return setmetatable(textclock, textclock.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