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

naughty: 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:26:00 +01:00
parent b78dd5e8b6
commit e49ab302b9
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/naughty.lua.in
View File

@ -148,13 +148,12 @@ for s = 1, screen.count() do
} }
end end
--- Evaluate desired position of the notification by index - internal -- Evaluate desired position of the notification by index - internal
-- @param idx Index of the notification -- @param idx Index of the notification
-- @param position top_right | top_left | bottom_right | bottom_left -- @param position top_right | top_left | bottom_right | bottom_left
-- @param height Popup height -- @param height Popup height
-- @param width Popup width (optional) -- @param width Popup width (optional)
-- @return Absolute position in {x, y} dictionary -- @return Absolute position in {x, y} dictionary
local function get_offset(screen, position, idx, width, height) local function get_offset(screen, position, idx, width, height)
local ws = capi.screen[screen].workarea local ws = capi.screen[screen].workarea
local v = {} local v = {}
@ -190,7 +189,7 @@ local function get_offset(screen, position, idx, width, height)
return v return v
end end
--- Re-arrange notifications according to their position and index - internal -- Re-arrange notifications according to their position and index - internal
-- @return None -- @return None
local function arrange(screen) local function arrange(screen)
for p,pos in pairs(notifications[screen]) do for p,pos in pairs(notifications[screen]) do
@ -216,7 +215,7 @@ function destroy(notification)
end end
end end
--- Get notification by ID -- Get notification by ID
-- @param id ID of the notification -- @param id ID of the notification
-- @return notification object if it was found, nil otherwise -- @return notification object if it was found, nil otherwise
local function getById(id) local function getById(id)
@ -232,7 +231,7 @@ local function getById(id)
end end
end end
--- Search for an icon in specified directories with a specified format -- Search for an icon in specified directories with a specified format
-- @param icon Name of the icon -- @param icon Name of the icon
-- @return full path of the icon, or nil of no icon was found -- @return full path of the icon, or nil of no icon was found
local function getIcon(name) local function getIcon(name)