awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc(awful.client): Document special signal semantics 

While the documentation already specified the signal via `@emits`, it
did not make it clear that this signal is emitted on a `tag` object,
rather than the `client`.

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
This commit is contained in:
Lucas Schwiderski 2021-05-22 01:24:07 +02:00
parent e0dea455c1
commit 1b49a20e0d
No known key found for this signature in database
GPG Key ID: AA12679AAA6DF4D8
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/awful/client.lua
View File

@ -1159,10 +1159,13 @@ end
--- Change window factor of a client. --- Change window factor of a client.
-- --
-- This will emit `property::windowfact` on the specific tag object
-- `c.screen.selected_tag`.
--
-- @legacylayout awful.client.incwfact -- @legacylayout awful.client.incwfact
-- @tparam number add Amount to increase/decrease the client's window factor. -- @tparam number add Amount to increase/decrease the client's window factor by.
-- Should be between `-current_window_factor` and something close to -- Should be between `-current_window_factor` and something close to
-- infinite. The normalisation then ensures that the sum of all factors is 1. -- infinite. Normalisation then ensures that the sum of all factors is 1.
-- @tparam client c the client. -- @tparam client c the client.
-- @emits property::windowfact -- @emits property::windowfact
function client.incwfact(add, c) function client.incwfact(add, c)