diff --git a/lib/menubar/init.lua.in b/lib/menubar/init.lua.in index a6bed5bd7..6d11b2050 100644 --- a/lib/menubar/init.lua.in +++ b/lib/menubar/init.lua.in @@ -1,7 +1,23 @@ --------------------------------------------------------------------------- +--- Menubar module, which aims to provide a freedesktop menu alternative +-- +-- List of menubar keybindings: +-- --- +-- +-- * "Left" | "C-j" select an item on the left +-- * "Right" | "C-k" select an item on the right +-- * "Backspace" exit the current category if we are in any +-- * "Escape" exit the current directory or exit menubar +-- * "Home" select the first item +-- * "End" select the last +-- * "Return" execute the entry +-- * "C-Return" execute the command with awful.util.spawn +-- * "C-M-Return" execute the command in a terminal +-- -- @author Alexander Yakushev <yakushev.alex@gmail.com> -- @copyright 2011-2012 Alexander Yakushev -- @release @AWESOME_VERSION@ +-- @module menubar --------------------------------------------------------------------------- -- Grab environment we need @@ -21,22 +37,6 @@ menubar.menu_gen = require("menubar.menu_gen") menubar.utils = require("menubar.utils") local compute_text_width = menubar.utils.compute_text_width ---- List of menubar keybindings: ---

--- --- @class table --- @name Menubar keybindings - -- Options section --- When true the .desktop files will be reparsed only when the diff --git a/lib/menubar/menu_gen.lua.in b/lib/menubar/menu_gen.lua.in index 7089bcca9..7ce000875 100644 --- a/lib/menubar/menu_gen.lua.in +++ b/lib/menubar/menu_gen.lua.in @@ -1,7 +1,10 @@ --------------------------------------------------------------------------- +-- Menu generation module for menubar +-- -- @author Antonio Terceiro -- @copyright 2009, 2011-2012 Antonio Terceiro, Alexander Yakushev -- @release @AWESOME_VERSION@ +-- @module menubar.menu_gen --------------------------------------------------------------------------- -- Grab environment @@ -11,8 +14,6 @@ local ipairs = ipairs local string = string local table = table --- Menu generation module for menubar --- menubar.menu_gen local menu_gen = {} -- Options section diff --git a/lib/menubar/utils.lua.in b/lib/menubar/utils.lua.in index 69524c9df..e9675eb1a 100644 --- a/lib/menubar/utils.lua.in +++ b/lib/menubar/utils.lua.in @@ -1,7 +1,10 @@ --------------------------------------------------------------------------- +-- Utility module for menubar +-- -- @author Antonio Terceiro -- @copyright 2009, 2011-2012 Antonio Terceiro, Alexander Yakushev -- @release @AWESOME_VERSION@ +-- @module menubar.utils --------------------------------------------------------------------------- -- Grab environment @@ -14,8 +17,6 @@ local theme = require("beautiful") local glib = require("lgi").GLib local wibox = require("wibox") --- Utility module for menubar --- menubar.utils local utils = {} -- NOTE: This icons/desktop files module was written according to the