doc: Polish the awful.widget doc.

A lot of them were missing the inheritance includes.
This commit is contained in:
Emmanuel Lepage-Vallee 2019-12-21 21:53:57 -08:00
parent 9f42f57a76
commit 833948ea67
8 changed files with 30 additions and 0 deletions

View File

@ -84,6 +84,7 @@ end
--
-- @property client
-- @param client
-- @propemits true false
function clienticon:get_client()
return self._private.client
@ -94,6 +95,7 @@ function clienticon:set_client(c)
self._private.client = c
self:emit_signal("widget::layout_changed")
self:emit_signal("widget::redraw_needed")
self:emit_signal("property::client", c)
end
--- Returns a new clienticon.

View File

@ -310,6 +310,10 @@ function keyboardlayout.mt:__call(...)
return _instance
end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(keyboardlayout, keyboardlayout.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -50,6 +50,10 @@ function launcher.mt:__call(...)
return launcher.new(...)
end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(launcher, launcher.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -178,12 +178,14 @@ local layoutlist = {}
-- automatically.
-- @property base_layout
-- @param widget
-- @propemits true false
-- @see wibox.layout.fixed.vertical
-- @see base_layout
--- The delegate widget template.
-- @property widget_template
-- @param table
-- @propemits true false
--- The layoutlist screen.
-- @property screen
@ -329,6 +331,7 @@ function layoutlist:set_base_layout(layout)
self:emit_signal("widget::layout_changed")
self:emit_signal("widget::redraw_needed")
self:emit_signal("property::base_layout", layout)
end
function layoutlist:set_widget_template(widget_template)
@ -345,6 +348,7 @@ function layoutlist:set_widget_template(widget_template)
self:emit_signal("widget::layout_changed")
self:emit_signal("widget::redraw_needed")
self:emit_signal("property::widget_template", widget_template)
end
function layoutlist:layout(_, width, height)

View File

@ -158,6 +158,10 @@ function widgetprompt.mt:__call(...)
return widgetprompt.new(...)
end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(widgetprompt, widgetprompt.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -607,6 +607,10 @@ function taglist.mt:__call(...)
return taglist.new(...)
end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(taglist, taglist.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -739,6 +739,10 @@ function tasklist.mt:__call(...)
return tasklist.new(...)
end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(tasklist, tasklist.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

View File

@ -88,6 +88,10 @@ function watch.mt.__call(_, ...)
return watch.new(...)
end
--@DOC_widget_COMMON@
--@DOC_object_COMMON@
return setmetatable(watch, watch.mt)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80