From df116331a1ecb8a22a79f0131c346167f6aa0065 Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Sun, 12 Dec 2010 21:45:54 +0100 Subject: [PATCH] Improve wibox' API documentation 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 4375c1d1..72701808 100644 --- a/lib/wibox/init.lua.in +++ b/lib/wibox/init.lua.in @@ -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