From 9031a813968beb0af565703aecb1e9e41ebc28b1 Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Sat, 12 Dec 2015 20:10:27 +0100 Subject: [PATCH] doc fixes to awful.menu.clients --- lib/awful/menu.lua | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/lib/awful/menu.lua b/lib/awful/menu.lua index 2d542267c..ca8a90f33 100644 --- a/lib/awful/menu.lua +++ b/lib/awful/menu.lua @@ -459,12 +459,13 @@ end -------------------------------------------------------------------------------- ---- Build a popup menu with running clients and shows it. --- @param args Menu table, see new() function for more informations. --- @param item_args Table that will be merged into each item, see new() for more --- informations. --- @param filter A function taking a client as an argument and returning true or --- false to indicate whether the client should be included in the menu. +--- Build a popup menu with running clients and show it. +-- @tparam[opt] table args Menu table, see `new()` for more information. +-- @tparam[opt] table item_args Table that will be merged into each item, see +-- `new()` for more information. +-- @tparam[opt] func filter A function taking a client as an argument and +-- returning `true` or `false` to indicate whether the client should be +-- included in the menu. -- @return The menu. function menu.clients(args, item_args, filter) local cls_t = {}