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

Merge pull request #2537 from blueyed/fix-treturn 

doc: fix `@treturn` usage with index_theme:get_per_directory_keys
This commit is contained in:
mergify[bot] 2019-01-05 09:00:06 +00:00 committed by GitHub
parent e647166ad6 ef4f3277b0
commit dab2732bc3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/menubar/index_theme.lua
View File

@ -149,11 +149,11 @@ end
--- Query (part of) per-directory keys of a given subdirectory name.
-- @deprecated menubar.index_theme:get_per_directory_keys
-- @tparam table subdirectory Icon theme's subdirectory
-- @treturn[1] string Value of the `Type` key
-- @treturn[2] number Value of the `Size` key
-- @treturn[3] number VAlue of the `MinSize` key
-- @treturn[4] number Value of the `MaxSize` key
-- @treturn[5] number Value of the `Threshold` key
-- @treturn string Value of the `Type` key
-- @treturn number Value of the `Size` key
-- @treturn number VAlue of the `MinSize` key
-- @treturn number Value of the `MaxSize` key
-- @treturn number Value of the `Threshold` key
function index_theme:get_per_directory_keys(subdirectory)
local keys = self.per_directory_keys[subdirectory]
return keys[TYPE], keys[SIZE], keys[MINSIZE], keys[MAXSIZE], keys[THRESHOLD]