Minor doc fixes
This commit is contained in:
parent
bca0b546d3
commit
ed69ed9529
|
@ -10,7 +10,7 @@ local aclient = require("awful.client")
|
||||||
local atag = require("awful.tag")
|
local atag = require("awful.tag")
|
||||||
|
|
||||||
--- When loaded, this module makes sure that there's always a client that will have focus
|
--- 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
|
-- awful.autofocus
|
||||||
|
|
||||||
-- Give focus when clients appear/disappear.
|
-- Give focus when clients appear/disappear.
|
||||||
|
|
|
@ -55,23 +55,22 @@ end
|
||||||
-- A callback can return false to pass the events to the next key grabber in the stack.
|
-- 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.
|
-- @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`
|
-- @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.
|
-- using keyboard.
|
||||||
-- <p><code>
|
|
||||||
-- function resize(c) <br/>
|
|
||||||
-- local grabber = awful.keygrabber.run(function(mod, key, event) </br>
|
|
||||||
-- if event == "release" then return end </br></br>
|
|
||||||
--
|
--
|
||||||
-- if key == 'Up' then awful.client.moveresize(0, 0, 0, 5, c) <br/>
|
-- function resize(c)
|
||||||
-- elseif key == 'Down' then awful.client.moveresize(0, 0, 0, -5, c) <br/>
|
-- local grabber = awful.keygrabber.run(function(mod, key, event)
|
||||||
-- elseif key == 'Right' then awful.client.moveresize(0, 0, 5, 0, c) <br/>
|
-- if event == "release" then return end
|
||||||
-- elseif key == 'Left' then awful.client.moveresize(0, 0, -5, 0, c) <br/>
|
|
||||||
-- else awful.keygrabber.stop(grabber) <br/>
|
|
||||||
-- end <br/><br/>
|
|
||||||
--
|
--
|
||||||
-- end) <br/>
|
-- if key == 'Up' then awful.client.moveresize(0, 0, 0, 5, c)
|
||||||
-- end <br/>
|
-- elseif key == 'Down' then awful.client.moveresize(0, 0, 0, -5, c)
|
||||||
-- </code></p>
|
-- 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)
|
function keygrabber.run(g)
|
||||||
-- Remove the grabber if its in stack
|
-- Remove the grabber if its in stack
|
||||||
keygrabber.stop(g)
|
keygrabber.stop(g)
|
||||||
|
|
|
@ -77,7 +77,7 @@ local function do_tile(param, orientation)
|
||||||
local t = tag.selected(param.screen)
|
local t = tag.selected(param.screen)
|
||||||
orientation = orientation or "right"
|
orientation = orientation or "right"
|
||||||
|
|
||||||
-- this handles are different orientations
|
-- This handles all different orientations.
|
||||||
local height = "height"
|
local height = "height"
|
||||||
local width = "width"
|
local width = "width"
|
||||||
local x = "x"
|
local x = "x"
|
||||||
|
|
|
@ -453,7 +453,7 @@ end
|
||||||
|
|
||||||
---
|
---
|
||||||
-- Returns an iterator to cycle through, starting from the first element or the
|
-- 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 t the table to iterate
|
||||||
-- @param filter a function that returns true to indicate a positive match
|
-- @param filter a function that returns true to indicate a positive match
|
||||||
|
|
|
@ -1149,7 +1149,7 @@ client_unban(client_t *c)
|
||||||
void
|
void
|
||||||
client_unmanage(client_t *c, bool window_valid)
|
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)
|
foreach(_tc, globalconf.clients)
|
||||||
{
|
{
|
||||||
client_t *tc = *_tc;
|
client_t *tc = *_tc;
|
||||||
|
@ -1629,7 +1629,7 @@ HANDLE_TITLEBAR(right, CLIENT_TITLEBAR_RIGHT)
|
||||||
HANDLE_TITLEBAR(bottom, CLIENT_TITLEBAR_BOTTOM)
|
HANDLE_TITLEBAR(bottom, CLIENT_TITLEBAR_BOTTOM)
|
||||||
HANDLE_TITLEBAR(left, CLIENT_TITLEBAR_LEFT)
|
HANDLE_TITLEBAR(left, CLIENT_TITLEBAR_LEFT)
|
||||||
|
|
||||||
/** Return client geometry.
|
/** Return or set client geometry.
|
||||||
* \param L The Lua VM state.
|
* \param L The Lua VM state.
|
||||||
* \return The number of elements pushed on stack.
|
* \return The number of elements pushed on stack.
|
||||||
* \luastack
|
* \luastack
|
||||||
|
|
Loading…
Reference in New Issue