From 81064daa42f45f18c004b6c786d53a278e45a677 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Tue, 3 May 2016 01:18:08 -0400 Subject: [PATCH] doc: Fix find_widgets() doc. --- lib/wibox/init.lua | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/wibox/init.lua b/lib/wibox/init.lua index 213da7e67..ae4693d9f 100644 --- a/lib/wibox/init.lua +++ b/lib/wibox/init.lua @@ -245,10 +245,11 @@ end --- Find a widget by a point. -- The wibox must have drawn itself at least once for this to work. --- @param x X coordinate of the point --- @param y Y coordinate of the point --- @return A sorted table with all widgets that contain the given point. The --- widgets are sorted by relevance. +-- @tparam number x X coordinate of the point +-- @tparam number y Y coordinate of the point +-- @treturn table A sorted table of widgets positions. The first element is the biggest +-- container while the last is the topmost widget. The table contains *x*, *y*, +-- *width*, *height* and *widget*. function wibox:find_widgets(x, y) return self._drawable:find_widgets(x, y) end