Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

tasklist: Fix documented function names (#3276)

This commit is contained in:
James R 2021-03-22 16:28:53 -06:00 committed by GitHub
parent ce5196424e
commit aeb2d85dad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lib/awful/widget/tasklist.lua
View File

@ -508,7 +508,7 @@ end
-- update. See `awful.widget.common.list_update`. -- update. See `awful.widget.common.list_update`.
-- @tparam[opt] table args.layout Container widget for tag widgets. Default -- @tparam[opt] table args.layout Container widget for tag widgets. Default
-- is `wibox.layout.flex.horizontal`. -- is `wibox.layout.flex.horizontal`.
-- @tparam[opt=awful.tasklist.source.all_clients] function args.source The -- @tparam[opt=awful.widget.tasklist.source.all_clients] function args.source The
-- function used to generate the list of client. -- function used to generate the list of client.
-- @tparam[opt] table args.widget_template A custom widget to be used for each client -- @tparam[opt] table args.widget_template A custom widget to be used for each client
-- @tparam[opt={}] table args.style The style overrides default theme. -- @tparam[opt={}] table args.style The style overrides default theme.
@ -687,7 +687,7 @@ end
--- Filtering function to include all clients. --- Filtering function to include all clients.
-- @return true -- @return true
-- @filterfunction awful.tasklist.filter.allscreen -- @filterfunction awful.widget.tasklist.filter.allscreen
function tasklist.filter.allscreen() function tasklist.filter.allscreen()
return true return true
end end
@ -696,7 +696,7 @@ end
-- @param c The client. -- @param c The client.
-- @param screen The screen we are drawing on. -- @param screen The screen we are drawing on.
-- @return true if c is on screen, false otherwise -- @return true if c is on screen, false otherwise
-- @filterfunction awful.tasklist.filter.alltags -- @filterfunction awful.widget.tasklist.filter.alltags
function tasklist.filter.alltags(c, screen) function tasklist.filter.alltags(c, screen)
-- Only print client on the same screen as this widget -- Only print client on the same screen as this widget
return get_screen(c.screen) == get_screen(screen) return get_screen(c.screen) == get_screen(screen)
@ -706,7 +706,7 @@ end
-- @param c The client. -- @param c The client.
-- @param screen The screen we are drawing on. -- @param screen The screen we are drawing on.
-- @return true if c is in a selected tag on screen, false otherwise -- @return true if c is in a selected tag on screen, false otherwise
-- @filterfunction awful.tasklist.filter.currenttags -- @filterfunction awful.widget.tasklist.filter.currenttags
function tasklist.filter.currenttags(c, screen) function tasklist.filter.currenttags(c, screen)
screen = get_screen(screen) screen = get_screen(screen)
-- Only print client on the same screen as this widget -- Only print client on the same screen as this widget
@ -731,7 +731,7 @@ end
-- @param c The client. -- @param c The client.
-- @param screen The screen we are drawing on. -- @param screen The screen we are drawing on.
-- @return true if c is in a selected tag on screen and is minimized, false otherwise -- @return true if c is in a selected tag on screen and is minimized, false otherwise
-- @filterfunction awful.tasklist.filter.minimizedcurrenttags -- @filterfunction awful.widget.tasklist.filter.minimizedcurrenttags
function tasklist.filter.minimizedcurrenttags(c, screen) function tasklist.filter.minimizedcurrenttags(c, screen)
screen = get_screen(screen) screen = get_screen(screen)
-- Only print client on the same screen as this widget -- Only print client on the same screen as this widget
@ -759,7 +759,7 @@ end
-- @param c The client. -- @param c The client.
-- @param screen The screen we are drawing on. -- @param screen The screen we are drawing on.
-- @return true if c is focused on screen, false otherwise -- @return true if c is focused on screen, false otherwise
-- @filterfunction awful.tasklist.filter.focused -- @filterfunction awful.widget.tasklist.filter.focused
function tasklist.filter.focused(c, screen) function tasklist.filter.focused(c, screen)
-- Only print client on the same screen as this widget -- Only print client on the same screen as this widget
return get_screen(c.screen) == get_screen(screen) and c.active return get_screen(c.screen) == get_screen(screen) and c.active
@ -769,7 +769,7 @@ end
-- --
-- This is the default source. -- This is the default source.
-- --
-- @sourcefunction awful.tasklist.source.all_clients -- @sourcefunction awful.widget.tasklist.source.all_clients
function tasklist.source.all_clients() function tasklist.source.all_clients()
return capi.client.get() return capi.client.get()
end end