menubar: Fix API docs
ldoc wants documentation comments to start with "---", not just "--". Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
parent
2936f63d67
commit
aa51379be0
|
@ -38,16 +38,16 @@ menubar.utils = require("menubar.utils")
|
||||||
|
|
||||||
-- Options section
|
-- Options section
|
||||||
|
|
||||||
-- When true the .desktop files will be reparsed only when the
|
--- When true the .desktop files will be reparsed only when the
|
||||||
-- extension is initialized. Use this if menubar takes much time to
|
-- extension is initialized. Use this if menubar takes much time to
|
||||||
-- open.
|
-- open.
|
||||||
menubar.cache_entries = true
|
menubar.cache_entries = true
|
||||||
|
|
||||||
-- When true the categories will be shown alongside application
|
--- When true the categories will be shown alongside application
|
||||||
-- entries.
|
-- entries.
|
||||||
menubar.show_categories = true
|
menubar.show_categories = true
|
||||||
|
|
||||||
-- Specifies the geometry of the menubar. This is a table with the keys
|
--- Specifies the geometry of the menubar. This is a table with the keys
|
||||||
-- x, y, width and height. Missing values are replaced via the screen's
|
-- x, y, width and height. Missing values are replaced via the screen's
|
||||||
-- geometry. However, missing height is replaced by the font size.
|
-- geometry. However, missing height is replaced by the font size.
|
||||||
menubar.geometry = { width = nil,
|
menubar.geometry = { width = nil,
|
||||||
|
@ -55,7 +55,7 @@ menubar.geometry = { width = nil,
|
||||||
x = nil,
|
x = nil,
|
||||||
y = nil }
|
y = nil }
|
||||||
|
|
||||||
-- Allows user to specify custom parameters for prompt.run function
|
--- Allows user to specify custom parameters for prompt.run function
|
||||||
-- (like colors).
|
-- (like colors).
|
||||||
menubar.prompt_args = {}
|
menubar.prompt_args = {}
|
||||||
|
|
||||||
|
|
|
@ -17,11 +17,11 @@ local menu_gen = {}
|
||||||
|
|
||||||
-- Options section
|
-- Options section
|
||||||
|
|
||||||
-- Specifies all directories where menubar should look for .desktop
|
--- Specifies all directories where menubar should look for .desktop
|
||||||
-- files. The search is not recursive.
|
-- files. The search is not recursive.
|
||||||
menu_gen.all_menu_dirs = { '/usr/share/applications/', '/usr/local/share/applications/' }
|
menu_gen.all_menu_dirs = { '/usr/share/applications/', '/usr/local/share/applications/' }
|
||||||
|
|
||||||
-- Specify the mapping of .desktop Categories section to the
|
--- Specify the mapping of .desktop Categories section to the
|
||||||
-- categories in the menubar. If "use" flag is set to false then any of
|
-- categories in the menubar. If "use" flag is set to false then any of
|
||||||
-- the applications that fall only to this category will not be shown.
|
-- the applications that fall only to this category will not be shown.
|
||||||
menu_gen.all_categories = {
|
menu_gen.all_categories = {
|
||||||
|
|
|
@ -23,14 +23,14 @@ local utils = {}
|
||||||
|
|
||||||
-- Options section
|
-- Options section
|
||||||
|
|
||||||
-- Terminal which applications that need terminal would open in.
|
--- Terminal which applications that need terminal would open in.
|
||||||
utils.terminal = 'xterm'
|
utils.terminal = 'xterm'
|
||||||
|
|
||||||
-- The default icon for applications that don't provide any icon in
|
-- The default icon for applications that don't provide any icon in
|
||||||
-- their .desktop files.
|
-- their .desktop files.
|
||||||
local default_icon = nil
|
local default_icon = nil
|
||||||
|
|
||||||
-- Name of the WM for the OnlyShownIn entry in the .desktop file.
|
--- Name of the WM for the OnlyShownIn entry in the .desktop file.
|
||||||
utils.wm_name = "awesome"
|
utils.wm_name = "awesome"
|
||||||
|
|
||||||
-- Private section
|
-- Private section
|
||||||
|
|
Loading…
Reference in New Issue