On 12/05/12 04:49, Anurag Priyam wrote: > On Wed, May 9, 2012 at 8:47 PM, Uli Schlachter <[email protected]> wrote: >> On 07.05.2012 07:06, Anurag Priyam wrote: >>> On Mon, May 7, 2012 at 2:56 AM, Ignas Anikevicius <[email protected]> >>> wrote: >>>>>> Patch6 should add some documentation to menubar, but I am not familiar >>>>>> with luadoc, so it somehow does not work. >>>> [...] > I am not sure it is a good idea to expose local functions via luadoc. > It is repeated throughout in the patch. > > Its perhaps best to simply recreate the patch documenting the keybindings > only.
I was also wondering, whether those extra '-' are really necessary. I have removed them and now only the documentation is added. It is slightly ugly in the list of the contents, but I have no idea how to fix it since there is no table called "Menubar key-bindings". I guess we could leave it as it is for now and then if/when we implement custom key-bindings, we can update the documentation. I'm attaching the last patch. Thanks, Ignas
>From d8591926ed0ec321c225f679f87b9cec00ca331f Mon Sep 17 00:00:00 2001 From: "Ignas Anikevicius (gns_ank)" <[email protected]> Date: Thu, 10 May 2012 09:29:10 +0100 Subject: [PATCH] Menubar: document keybindings, some luadoc fixes. This adds the documentation about keybindings for luadoc. Signed-off-by: Ignas Anikevicius (gns_ank) <[email protected]> --- lib/menubar/init.lua.in | 16 ++++++++++++++++ 1 files changed, 16 insertions(+), 0 deletions(-) diff --git a/lib/menubar/init.lua.in b/lib/menubar/init.lua.in index ebbb03c..6ee801e 100644 --- a/lib/menubar/init.lua.in +++ b/lib/menubar/init.lua.in @@ -28,6 +28,22 @@ local setmetatable = setmetatable module("menubar") +--- List of menubar keybindings: +-- <p><ul> +-- <li>"Left" | "C-j" select an item on the left</li> +-- <li>"Right" | "C-k" select an item on the right</li> +-- <li>"Backspace" exit the current category if we are in any</li> +-- <li>"Escape" exit the current directory or exit menubar</li> +-- <li>"Home" select the first item</li> +-- <li>"End" select the last</li> +-- <li>"Return" execute the entry</li> +-- <li>"C-Return" execute the command with awful.util.spawn</li> +-- <li>"C-M-Return" execute the command in a terminal> +-- </ul></p> +-- +-- @class table +-- @name Menubar keybindings + -- Options section -- When true the .desktop files will be reparsed only when the -- 1.7.8.5
