From 9c3731c782a5a5733d30f1f21b3e9dc560ad117e Mon Sep 17 00:00:00 2001 From: Anurag Priyam Date: Thu, 27 Jan 2011 01:51:53 +0530 Subject: [PATCH] add markup to awful.menu.new's documentation Display the possible keys to the 'menu' params as a bullet list (unreadable otherwise). Signed-off-by: Anurag Priyam Signed-off-by: Uli Schlachter --- lib/awful/menu.lua.in | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/awful/menu.lua.in b/lib/awful/menu.lua.in index 772f214c..6ea87a06 100644 --- a/lib/awful/menu.lua.in +++ b/lib/awful/menu.lua.in @@ -378,7 +378,12 @@ function toggle(menu, args) end --- Open a menu popup. --- @param menu Table containing the menu informations. Key items: Table containing the displayed items, each element is a tab containing: item name, triggered action, submenu table or function, item icon (optional). Keys [fg|bg]_[focus|normal], border, border_width, submenu_icon, height and width override the default display for your menu, each of them are optional. Key auto_expand controls the submenu auto expand behaviour by setting it to true (default) or false. +-- @param menu Table containing the menu informations.
+--
    +--
  • Key items: Table containing the displayed items, each element is a tab containing: item name, triggered action, submenu table or function, item icon (optional).
    • +--
  • Keys [fg|bg]_[focus|normal], border, border_width, submenu_icon, height and width override the default display for your menu, each of them are optional.
    • +--
  • Key auto_expand controls the submenu auto expand behaviour by setting it to true (default) or false.
    • +--
-- @param parent Specify the parent menu if we want to open a submenu, this value should never be set by the user. -- @param num Specify the parent's clicked item number if we want to open a submenu, this value should never be set by the user. function new(menu, parent, num)