From 3ec32306db4435350e998068c652e0253c1cb4cc Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Tue, 14 Dec 2010 21:07:04 +0100 Subject: [PATCH] (Try to) document the wibox constructor Signed-off-by: Uli Schlachter --- lib/wibox/init.lua.in | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/wibox/init.lua.in b/lib/wibox/init.lua.in index 727018087..18d002d2e 100644 --- a/lib/wibox/init.lua.in +++ b/lib/wibox/init.lua.in @@ -315,6 +315,14 @@ end -- @name draw -- @class function +--- Widget box object. +-- Every wibox "inherits" from a drawin and you can use all of drawin's +-- functions directly on this as well. When creating a wibox, you can specify a +-- "fg" and a "bg" color as keys in the table that is passed to the constructor. +-- All other arguments will be passed to drawin's constructor. +-- @class table +-- @name drawin + setmetatable(_M, { __call = function(_, ...) return new(...) end }) -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80