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 <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2016-10-01 16:09:30 +02:00
parent 6224fc6751
commit 9045add3f0
1 changed files with 4 additions and 18 deletions

View File

@ -101,26 +101,12 @@
--- When the mouse enter a widget. --- When the mouse enter a widget.
-- @signal mouse::enter -- @signal mouse::enter
-- @tparam table widget The widget -- @tparam table find_widgets_result The entry from the result of
-- @tparam table geometry -- `wibox.drawable:find_widgets()` for the position that the mouse hit.
-- @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`
-- @see mouse -- @see mouse
--- When the mouse leave a widget. --- When the mouse leave a widget.
-- @signal mouse::leave -- @signal mouse::leave
-- @tparam table widget The widget -- @tparam table find_widgets_result The entry from the result of
-- @tparam table geometry -- `wibox.drawable:find_widgets()` for the position that the mouse hit.
-- @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`
-- @see mouse -- @see mouse