Improve wibox' API documentation

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2010-12-12 21:45:54 +01:00
parent 07bbe14d02
commit df116331a1
1 changed files with 8 additions and 0 deletions

View File

@ -22,6 +22,8 @@ local sort = require("gears.sort")
local beautiful = require("beautiful")
local string_format = string.format
--- This provides widget box windows. Every wibox can also be used as if it were
-- a drawin. All drawin functions and properties are also available on wiboxes!
module("wibox")
local function do_redraw(wibox)
@ -307,6 +309,12 @@ local function new(args)
return ret
end
--- Redraw a wibox. You should never have to call this explicitely because it is
-- automatically called when needed.
-- @param wibox
-- @name draw
-- @class function
setmetatable(_M, { __call = function(_, ...) return new(...) end })
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80