From a15e53deec397cf6306f7ebd9432861dfead276f Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Sat, 15 Mar 2014 02:56:58 +0100 Subject: [PATCH] Minor doc fixes --- lib/awful/autofocus.lua.in | 2 +- lib/awful/keygrabber.lua.in | 27 +++++++++++++-------------- lib/awful/layout/suit/tile.lua.in | 2 +- lib/awful/util.lua.in | 2 +- objects/client.c | 4 ++-- 5 files changed, 18 insertions(+), 19 deletions(-) diff --git a/lib/awful/autofocus.lua.in b/lib/awful/autofocus.lua.in index 271b29fc8..74c1fe0b3 100644 --- a/lib/awful/autofocus.lua.in +++ b/lib/awful/autofocus.lua.in @@ -10,7 +10,7 @@ local aclient = require("awful.client") local atag = require("awful.tag") --- When loaded, this module makes sure that there's always a client that will have focus --- on event such as tag switching, client unmanaging, etc. +-- on events such as tag switching, client unmanaging, etc. -- awful.autofocus -- Give focus when clients appear/disappear. diff --git a/lib/awful/keygrabber.lua.in b/lib/awful/keygrabber.lua.in index e1deef803..3240da786 100644 --- a/lib/awful/keygrabber.lua.in +++ b/lib/awful/keygrabber.lua.in @@ -55,23 +55,22 @@ end -- A callback can return false to pass the events to the next key grabber in the stack. -- @param g The key grabber callback that will get the key events until it will be deleted or a new grabber is added. -- @return the given callback `g` --- @usage Following function can be bound to a key, and used to resize a client +-- @usage The following function can be bound to a key, and used to resize a client -- using keyboard. ---

--- function resize(c)
--- local grabber = awful.keygrabber.run(function(mod, key, event)
--- if event == "release" then return end

-- --- if key == 'Up' then awful.client.moveresize(0, 0, 0, 5, c)
--- elseif key == 'Down' then awful.client.moveresize(0, 0, 0, -5, c)
--- elseif key == 'Right' then awful.client.moveresize(0, 0, 5, 0, c)
--- elseif key == 'Left' then awful.client.moveresize(0, 0, -5, 0, c)
--- else awful.keygrabber.stop(grabber)
--- end

+-- function resize(c) +-- local grabber = awful.keygrabber.run(function(mod, key, event) +-- if event == "release" then return end -- --- end)
--- end
---

+-- if key == 'Up' then awful.client.moveresize(0, 0, 0, 5, c) +-- elseif key == 'Down' then awful.client.moveresize(0, 0, 0, -5, c) +-- elseif key == 'Right' then awful.client.moveresize(0, 0, 5, 0, c) +-- elseif key == 'Left' then awful.client.moveresize(0, 0, -5, 0, c) +-- else awful.keygrabber.stop(grabber) +-- end +-- +-- end) +-- end function keygrabber.run(g) -- Remove the grabber if its in stack keygrabber.stop(g) diff --git a/lib/awful/layout/suit/tile.lua.in b/lib/awful/layout/suit/tile.lua.in index 8c3b2c712..c5500236c 100644 --- a/lib/awful/layout/suit/tile.lua.in +++ b/lib/awful/layout/suit/tile.lua.in @@ -77,7 +77,7 @@ local function do_tile(param, orientation) local t = tag.selected(param.screen) orientation = orientation or "right" - -- this handles are different orientations + -- This handles all different orientations. local height = "height" local width = "width" local x = "x" diff --git a/lib/awful/util.lua.in b/lib/awful/util.lua.in index 4c6424d8e..1ac1aa179 100644 --- a/lib/awful/util.lua.in +++ b/lib/awful/util.lua.in @@ -453,7 +453,7 @@ end --- -- Returns an iterator to cycle through, starting from the first element or the --- given index, all elments of a table that match a given criteria. +-- given index, all elements of a table that match a given criteria. -- -- @param t the table to iterate -- @param filter a function that returns true to indicate a positive match diff --git a/objects/client.c b/objects/client.c index 9639e8a2f..9b187f7f5 100644 --- a/objects/client.c +++ b/objects/client.c @@ -1149,7 +1149,7 @@ client_unban(client_t *c) void client_unmanage(client_t *c, bool window_valid) { - /* Reset transient_for attributes of widows that maybe referring to us */ + /* Reset transient_for attributes of windows that might be referring to us */ foreach(_tc, globalconf.clients) { client_t *tc = *_tc; @@ -1629,7 +1629,7 @@ HANDLE_TITLEBAR(right, CLIENT_TITLEBAR_RIGHT) HANDLE_TITLEBAR(bottom, CLIENT_TITLEBAR_BOTTOM) HANDLE_TITLEBAR(left, CLIENT_TITLEBAR_LEFT) -/** Return client geometry. +/** Return or set client geometry. * \param L The Lua VM state. * \return The number of elements pushed on stack. * \luastack