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

doc: improve client.dockable (#1336)

This commit is contained in:
Daniel Hahler 2016-12-31 00:40:17 +01:00 committed by GitHub
parent bdf4c3e0c0
commit af961e974c
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/awful/client.lua
View File

@ -924,12 +924,10 @@ function client.incwfact(add, c)
t:emit_signal("property::windowfact") t:emit_signal("property::windowfact")
end end
--- Get a client dockable state. --- Get a client's dockable state.
-- --
-- @client c A client. -- @client c A client.
-- @return True or false. Note that some windows might be dockable even if you -- @treturn bool
-- did not set them manually. For example, windows with a type "utility",
-- "toolbar" or "dock"
-- @deprecated awful.client.dockable.get -- @deprecated awful.client.dockable.get
function client.dockable.get(c) function client.dockable.get(c)
util.deprecate("Use c.dockable instead of awful.client.dockable.get") util.deprecate("Use c.dockable instead of awful.client.dockable.get")
@ -937,8 +935,12 @@ function client.dockable.get(c)
end end
--- If the client is dockable. --- If the client is dockable.
--
-- A dockable client is an application confined to the edge of the screen. The -- A dockable client is an application confined to the edge of the screen. The
-- space it occupy is substracted from the `screen.workarea`. -- space it occupies is substracted from the `screen.workarea`.
--
-- Clients with a type of "utility", "toolbar" or "dock" are dockable by
-- default.
-- --
-- **Signal:** -- **Signal:**
-- --
@ -962,7 +964,8 @@ function client.object.get_dockable(c)
return value return value
end end
--- Set a client dockable state, overriding auto-detection. --- Set a client's dockable state, overriding auto-detection.
--
-- With this enabled you can dock windows by moving them from the center -- With this enabled you can dock windows by moving them from the center
-- to the edge of the workarea. -- to the edge of the workarea.
-- --