naughty.core: Update the property documentation.

This commit is contained in:
Emmanuel Lepage Vallee 2022-08-21 23:02:26 -07:00
parent 85eb759bd8
commit c3a73cab53
1 changed files with 8 additions and 6 deletions

View File

@ -120,7 +120,7 @@ gtable.crush(naughty, require("naughty.constants"))
-- useful when watching movies or doing presentations.
--
-- @property suspended
-- @tparam boolean suspended
-- @tparam[opt=false] boolean suspended
-- @emits added
-- @propemits true false
@ -138,17 +138,19 @@ gtable.crush(naughty, require("naughty.constants"))
--
-- Please note that this list is kept up-to-date even in suspended mode.
--
-- **Signal:**
--
-- * property::active
--
-- @property active
-- @tparam table active
-- @tparam[opt={}] table active
-- @tablerowtype A list of `naughty.notification` objects.
-- @propemits false false
--- True when there is a handler connected to `request::display`.
--
-- Note that using the legacy notifications is deprecated.
--
-- @property has_display_handler
-- @tparam boolean has_display_handler
-- @propertydefault If `rc.lua` has a `request::display` section, this will
-- be `true`. Otherwise it is `false` and the legacy notification will be used.
--- If the timeout needs to be reset when a property changes.
--