naughty.action: Update the property documentation.

This commit is contained in:
Emmanuel Lepage Vallee 2022-08-21 23:02:26 -07:00
parent 05ecb513c5
commit 6b382148a8
1 changed files with 6 additions and 3 deletions

View File

@ -27,6 +27,7 @@ local action = {}
-- The action name. -- The action name.
-- @property name -- @property name
-- @tparam string name The name. -- @tparam string name The name.
-- @propertydefault This is provided by DBus.
-- @propemits true false -- @propemits true false
-- If the action is selected. -- If the action is selected.
@ -35,17 +36,19 @@ local action = {}
-- implement keyboard navigation. -- implement keyboard navigation.
-- --
-- @property selected -- @property selected
-- @tparam boolean selected -- @tparam[opt=false] boolean selected
-- @propemits true false -- @propemits true false
--- The action position (index). --- The action position (index).
-- @property position -- @property position
-- @tparam number position -- @tparam integer position
-- @propertydefault This is provided by DBus.
-- @propemits true false -- @propemits true false
-- @negativeallowed false
--- The action icon. --- The action icon.
-- @property icon -- @property icon
-- @tparam gears.surface|string icon -- @tparam[opt=nil] image|string|nil icon
-- @propemits true false -- @propemits true false
--- If the action should hide the label and only display the icon. --- If the action should hide the label and only display the icon.