diff --git a/lib/awful/keygrabber.lua.in b/lib/awful/keygrabber.lua.in index f1c98457..aac8ab1e 100644 --- a/lib/awful/keygrabber.lua.in +++ b/lib/awful/keygrabber.lua.in @@ -54,16 +54,15 @@ end -- to the top of the stack. -- -- The callback function receives three arguments: --- -- --- A callback can return false to pass the events to the next +-- * a table containing modifiers keys +-- * a string with the pressed key +-- * a string with either "press" or "release" to indicate the event type +-- +-- A callback can return `false` to pass the events to the next -- keygrabber in the stack. -- @param g The key grabber callback that will get the key events until it will be deleted or a new grabber is added. --- @return the given callback g. +-- @return the given callback `g`. -- @usage -- -- The following function can be bound to a key, and be used to resize a -- -- client using the keyboard. diff --git a/lib/awful/menu.lua.in b/lib/awful/menu.lua.in index 27f66aa9..ec782b1f 100644 --- a/lib/awful/menu.lua.in +++ b/lib/awful/menu.lua.in @@ -588,18 +588,18 @@ end -------------------------------------------------------------------------------- --- Create a menu popup. --- @param args Table containing the menu informations.
--- +-- @param args Table containing the menu informations. +-- +-- * Key items: Table containing the displayed items. Each element is a table by default (when element 'new' is awful.menu.entry) containing: item name, triggered action, submenu table or function, item icon (optional). +-- * Keys theme.[fg|bg]_[focus|normal], theme.border_color, theme.border_width, theme.submenu_icon, theme.height and theme.width override the default display for your menu and/or of your menu entry, 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. -- @usage -- The following function builds and shows a menu of clients that match -- -- a particular rule. -- -- Bound to a key, it can be used to select from dozens of terminals open on -- -- several tags. --- -- When using @{awful.rules.match_any} instead of @{awful.rules.match}, +-- -- When using @{rules.match_any} instead of @{rules.match}, -- -- a menu of clients with different classes could be build. -- -- function terminal_menu () diff --git a/lib/awful/prompt.lua.in b/lib/awful/prompt.lua.in index d9f2ea88..0c990abf 100644 --- a/lib/awful/prompt.lua.in +++ b/lib/awful/prompt.lua.in @@ -158,32 +158,32 @@ local function prompt_text_with_cursor(args) end --- Run a prompt in a box. ---

The following readline keyboard shortcuts are implemented as expected:

+-- +-- The following readline keyboard shortcuts are implemented as expected: -- CTRL+A, CTRL+B, CTRL+C, CTRL+D, -- CTRL+E, CTRL+J, CTRL+M, CTRL+F, -- CTRL+H, CTRL+K, CTRL+U, CTRL+W, -- CTRL+BACKSPACE, SHIFT+INSERT, HOME, -- END and arrow keys. ---

The following shortcuts implement additional history manipulation commands +-- +-- The following shortcuts implement additional history manipulation commands -- where the search term is defined as the substring of the command from first --- character to cursor position.

--- --- @param args A table with optional arguments: fg_cursor, --- bg_cursor, ul_cursor, prompt, --- text, selectall, font, --- autoexec. +-- character to cursor position. +-- +-- * CTRL+R: reverse history search, matches any history entry +-- containing search term. +-- * CTRL+S: forward history search, matches any history entry +-- containing search term. +-- * CTRL+UP: ZSH up line or search, matches any history entry +-- starting with search term. +-- * CTRL+DOWN: ZSH down line or search, matches any history +-- entry starting with search term. +-- * CTRL+DELETE: delete the currently visible history entry from +-- history file. This does not delete new commands or history entries under +-- user editing. +-- +-- @tparam table args A table with optional arguments: `fg_cursor`, `bg_cursor`, +-- `ul_cursor`, `prompt`, `text`, `selectall`, `font`, `autoexec`. -- @param textbox The textbox to use for the prompt. -- @param exe_callback The callback function to call with command as argument -- when finished.