diff --git a/lib/awful/layout/init.lua.in b/lib/awful/layout/init.lua.in index 2d6588a3e..7735a9499 100755 --- a/lib/awful/layout/init.lua.in +++ b/lib/awful/layout/init.lua.in @@ -115,7 +115,7 @@ function layout.arrange(screen) end --- Get the current layout name. --- @param layout The layout. +-- @param _layout The layout. -- @return The layout name. function layout.getname(_layout) local _layout = _layout or layout.get() diff --git a/lib/awful/rules.lua.in b/lib/awful/rules.lua.in index bf90d5b4c..d4bad2532 100644 --- a/lib/awful/rules.lua.in +++ b/lib/awful/rules.lua.in @@ -149,7 +149,7 @@ end --- Get list of matching rules for a client. -- @param c The client. --- @param rule The rules to check. List with "rule", "rule_any", "except" and +-- @param _rules The rules to check. List with "rule", "rule_any", "except" and -- "except_any" keys. -- @return The list of matched rules. function rules.matching_rules(c, _rules) @@ -165,7 +165,7 @@ end --- Check if a client matches a given set of rules. -- @param c The client. --- @param rule The rules to check. List with "rule", "rule_any", "except" and +-- @param rules The rules to check. List with "rule", "rule_any", "except" and -- "except_any" keys. -- @return True if at least one rule is matched, false otherwise. function rules.does_match(c, rules) diff --git a/lib/awful/screen.lua.in b/lib/awful/screen.lua.in index 531056a97..ab544780b 100644 --- a/lib/awful/screen.lua.in +++ b/lib/awful/screen.lua.in @@ -44,7 +44,7 @@ function screen.getbycoord(x, y, default) end --- Give the focus to a screen, and move pointer. Keeps relative position of the pointer on the screen. --- @param screen Screen number. +-- @param _screen Screen number. function screen.focus(_screen) client = client or require("awful.client") if _screen > capi.screen.count() then _screen = capi.mouse.screen end diff --git a/lib/awful/wibox.lua.in b/lib/awful/wibox.lua.in index 1e359442b..f48ece3bc 100644 --- a/lib/awful/wibox.lua.in +++ b/lib/awful/wibox.lua.in @@ -204,7 +204,7 @@ end --- Create a new wibox and attach it to a screen edge. -- @see wibox --- @param args A table with standard arguments to wibox() creator. +-- @param arg A table with standard arguments to wibox() creator. -- You can add also position key with value top, bottom, left or right. -- You can also use width or height in % and set align to center, right or left. -- You can also set the screen key with a screen number to attach the wibox. diff --git a/lib/awful/widget/graph.lua.in b/lib/awful/widget/graph.lua.in index 4c14e1ed9..4f5dc134c 100644 --- a/lib/awful/widget/graph.lua.in +++ b/lib/awful/widget/graph.lua.in @@ -209,7 +209,6 @@ function graph:set_height(height) end --- Set the graph width. --- @param graph The graph. -- @param width The width to set. function graph:set_width(width) if width >= 5 then diff --git a/lib/menubar/utils.lua.in b/lib/menubar/utils.lua.in index 3759c5902..5eefe966d 100644 --- a/lib/menubar/utils.lua.in +++ b/lib/menubar/utils.lua.in @@ -194,7 +194,6 @@ end --- Parse a directory with .desktop files -- @param dir The directory. --- @param icons_size, The icons sizes, optional. -- @return A table with all .desktop entries. function utils.parse_dir(dir) local programs = {} diff --git a/lib/naughty.lua.in b/lib/naughty.lua.in index c24a247f3..6c3528e5b 100644 --- a/lib/naughty.lua.in +++ b/lib/naughty.lua.in @@ -61,11 +61,12 @@ naughty.config.notify_callback = nil -- @field low The preset for notifications with low urgency level -- @field normal The default preset for every notification without a preset that will also be used for normal urgency level -- @field critical The preset for notifications with a critical urgency level +-- @table naughty.config.presets naughty.config.presets = { - normal = {}, low = { timeout = 5 }, + normal = {}, critical = { bg = "#ff0000", fg = "#ffffff", @@ -120,6 +121,7 @@ local suspended = false -- @field width Popup width -- @field die Function to be executed on timeout -- @field id Unique notification id based on a counter +-- @table naughty.notifications naughty.notifications = { suspended = { } } for s = 1, capi.screen.count() do naughty.notifications[s] = { diff --git a/lib/wibox/drawable.lua.in b/lib/wibox/drawable.lua.in index 8282e6d0c..36ac58e5a 100644 --- a/lib/wibox/drawable.lua.in +++ b/lib/wibox/drawable.lua.in @@ -124,7 +124,6 @@ function drawable:set_widget(widget) end --- Set the background of the drawable --- @param drawable The drawable to use -- @param c The background to use. This must either be a cairo pattern object, -- nil or a string that gears.color() understands. function drawable:set_bg(c) @@ -155,7 +154,6 @@ function drawable:set_bg(c) end --- Set the foreground of the drawable --- @param drawable The drawable to use -- @param c The foreground to use. This must either be a cairo pattern object, -- nil or a string that gears.color() understands. function drawable:set_fg(c)