widgets: Make docs for button::press and release saner

Previously, this mentioned non-existent arguments (widget) and
duplicated parts of the (not yet really existing) API documentation for
find_widgets().

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2016-10-01 16:12:19 +02:00
parent eb9dbf991c
commit ca947730ff
1 changed files with 14 additions and 28 deletions

View File

@ -62,51 +62,37 @@
-- @see widget::layout_changed -- @see widget::layout_changed
--- When a mouse button is pressed over the widget. --- When a mouse button is pressed over the widget.
-- The position of the mouse press relative to the widget while geometry
-- contains the geometry of the widget relative to the wibox.
-- @signal button::press -- @signal button::press
-- @tparam table widget The widget -- @tparam number lx The horizontal position relative to the (0,0) position in
-- @tparam number lx The relative horizontal position. -- the widget.
-- @tparam number ly The relative vertical position. -- @tparam number ly The vertical position relative to the (0,0) position in the
-- widget.
-- @tparam number button The button number. -- @tparam number button The button number.
-- @tparam table mods The modifiers (mod4, mod1 (alt), Control, Shift) -- @tparam table mods The modifiers (mod4, mod1 (alt), Control, Shift)
-- @tparam table geometry -- @tparam table find_widgets_result The entry from the result of
-- @tparam number geometry.x The vertical position -- @{wibox.drawable:find_widgets} for the position that the mouse hit.
-- @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 a mouse button is released over the widget. --- When a mouse button is released over the widget.
-- The position of the mouse press relative to the widget while geometry
-- contains the geometry of the widget relative to the wibox.
-- @signal button::release -- @signal button::release
-- @tparam table widget The widget -- @tparam number lx The horizontal position relative to the (0,0) position in
-- @tparam number lx The relative horizontal position. -- the widget.
-- @tparam number ly The relative vertical position. -- @tparam number ly The vertical position relative to the (0,0) position in the
-- widget.
-- @tparam number button The button number. -- @tparam number button The button number.
-- @tparam table mods The modifiers (mod4, mod1 (alt), Control, Shift) -- @tparam table mods The modifiers (mod4, mod1 (alt), Control, Shift)
-- @tparam table geometry -- @tparam table find_widgets_result The entry from the result of
-- @tparam number geometry.x The vertical position -- @{wibox.drawable:find_widgets} for the position that the mouse hit.
-- @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 enter a widget. --- When the mouse enter a widget.
-- @signal mouse::enter -- @signal mouse::enter
-- @tparam table find_widgets_result The entry from the result of -- @tparam table find_widgets_result The entry from the result of
-- `wibox.drawable:find_widgets()` for the position that the mouse hit. -- @{wibox.drawable:find_widgets} for the position that the mouse hit.
-- @see mouse -- @see mouse
--- When the mouse leave a widget. --- When the mouse leave a widget.
-- @signal mouse::leave -- @signal mouse::leave
-- @tparam table find_widgets_result The entry from the result of -- @tparam table find_widgets_result The entry from the result of
-- `wibox.drawable:find_widgets()` for the position that the mouse hit. -- @{wibox.drawable:find_widgets} for the position that the mouse hit.
-- @see mouse -- @see mouse