Docs: Start menubar refactoring

Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
This commit is contained in:
Ignas Anikevicius (gns_ank) 2014-05-19 12:37:13 +01:00 committed by Daniel Hahler
parent 20eeb66541
commit a0051c7dc4
3 changed files with 22 additions and 20 deletions

View File

@ -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 &lt;yakushev.alex@gmail.com&gt;
-- @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:
-- <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</li>
-- </ul></p>
--
-- @class table
-- @name Menubar keybindings
-- Options section
--- When true the .desktop files will be reparsed only when the

View File

@ -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

View File

@ -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