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

awful.client: do not export documentation of local functions 

Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
Julien Danjou 2009-01-08 12:21:47 +01:00
parent d74358a2b1
commit fba27a5315
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/awful/client.lua.in
View File

@ -237,7 +237,7 @@ function next(i, c)
end end
end end
--- Return true whether client B is in the right direction -- Return true whether client B is in the right direction
-- compared to client A. -- compared to client A.
-- @param dir The direction. -- @param dir The direction.
-- @param cA The first client. -- @param cA The first client.
@ -256,7 +256,7 @@ local function is_in_direction(dir, cA, cB)
return false return false
end end
--- Calculate distance between two points. -- Calculate distance between two points.
-- i.e: if we want to move to the right, we will take the right border -- i.e: if we want to move to the right, we will take the right border
-- of the currently focused client and the left side of the checked client. -- of the currently focused client and the left side of the checked client.
-- This avoid the focus of an upper client when you move to the right in a -- This avoid the focus of an upper client when you move to the right in a
@ -284,7 +284,7 @@ local function calculate_distance(dir, cA, cB)
return math.sqrt(math.pow(xB - xA, 2) + math.pow(yB - yA, 2)) return math.sqrt(math.pow(xB - xA, 2) + math.pow(yB - yA, 2))
end end
--- Get the nearest client in the given direction -- Get the nearest client in the given direction
-- @param dir The direction, can be either "up", "down", "left" or "right". -- @param dir The direction, can be either "up", "down", "left" or "right".
-- @param c Optional client to get a client relative to. Else focussed is used. -- @param c Optional client to get a client relative to. Else focussed is used.
local function get_client_in_direction(dir, c) local function get_client_in_direction(dir, c)