From 9045add3f0f47cfcd13208046e623fec6aa18c88 Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Sat, 1 Oct 2016 16:09:30 +0200 Subject: [PATCH] Fix docs for mouse::enter and mouse::leave Just because they sound similar to mouse::press and mouse::release does not mean that the arguments are the same. Perhaps they should be, but that's another story. Signed-off-by: Uli Schlachter --- docs/common/widget.ldoc | 22 ++++------------------ 1 file changed, 4 insertions(+), 18 deletions(-) diff --git a/docs/common/widget.ldoc b/docs/common/widget.ldoc index c96e4fe38..b9abf7853 100644 --- a/docs/common/widget.ldoc +++ b/docs/common/widget.ldoc @@ -101,26 +101,12 @@ --- When the mouse enter a widget. -- @signal mouse::enter --- @tparam table widget The widget --- @tparam table geometry --- @tparam number geometry.x The vertical position --- @tparam number geometry.y The horizontal position --- @tparam number geometry.width The widget --- @tparam number geometry.height The height --- @tparam drawable geometry.drawable The `drawable` --- @tparam table geometry.matrix_to_parent The relative `gears.matrix` --- @tparam table geometry.matrix_to_device The absolute `gears.matrix` +-- @tparam table find_widgets_result The entry from the result of +-- `wibox.drawable:find_widgets()` for the position that the mouse hit. -- @see mouse --- When the mouse leave a widget. -- @signal mouse::leave --- @tparam table widget The widget --- @tparam table geometry --- @tparam number geometry.x The vertical position --- @tparam number geometry.y The horizontal position --- @tparam number geometry.width The widget --- @tparam number geometry.height The height --- @tparam drawable geometry.drawable The `drawable` --- @tparam table geometry.matrix_to_parent The relative `gears.matrix` --- @tparam table geometry.matrix_to_device The absolute `gears.matrix` +-- @tparam table find_widgets_result The entry from the result of +-- `wibox.drawable:find_widgets()` for the position that the mouse hit. -- @see mouse