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

doc: fix for awful.util.geticonpath

This commit is contained in:
Daniel Hahler 2015-02-26 15:40:00 +01:00
parent f66b52463d
commit 2930c0ab4a
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/awful/util.lua.in
View File

@ -185,12 +185,13 @@ function util.getdir(d)
end end
--- Search for an icon and return the full path. --- Search for an icon and return the full path.
-- It searches for the icon path under the directories given w/the right ext -- It searches for the icon path under the given directories with respect to the
-- given extensions for the icon filename.
-- @param iconname The name of the icon to search for. -- @param iconname The name of the icon to search for.
-- @param exts Table of image extensions allowed, otherwise { 'png', gif' } -- @param exts Table of image extensions allowed, otherwise { 'png', gif' }
-- @param dirs Table of dirs to search, otherwise { '/usr/share/pixmaps/' } -- @param dirs Table of dirs to search, otherwise { '/usr/share/pixmaps/' }
-- @param size Optional size. If this is specified, subdirectories <size>x<size> -- @tparam string size Optional size. If this is specified, subdirectories `x`
-- of the dirs are searched first -- of the dirs are searched first.
function util.geticonpath(iconname, exts, dirs, size) function util.geticonpath(iconname, exts, dirs, size)
local exts = exts or { 'png', 'gif' } local exts = exts or { 'png', 'gif' }
local dirs = dirs or { '/usr/share/pixmaps/', '/usr/share/icons/hicolor/' } local dirs = dirs or { '/usr/share/pixmaps/', '/usr/share/icons/hicolor/' }