Fix some random ldoc warnings
Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
parent
a7cdbf468b
commit
dcc348d75e
|
@ -115,7 +115,7 @@ function layout.arrange(screen)
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Get the current layout name.
|
--- Get the current layout name.
|
||||||
-- @param layout The layout.
|
-- @param _layout The layout.
|
||||||
-- @return The layout name.
|
-- @return The layout name.
|
||||||
function layout.getname(_layout)
|
function layout.getname(_layout)
|
||||||
local _layout = _layout or layout.get()
|
local _layout = _layout or layout.get()
|
||||||
|
|
|
@ -149,7 +149,7 @@ end
|
||||||
|
|
||||||
--- Get list of matching rules for a client.
|
--- Get list of matching rules for a client.
|
||||||
-- @param c The 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.
|
-- "except_any" keys.
|
||||||
-- @return The list of matched rules.
|
-- @return The list of matched rules.
|
||||||
function rules.matching_rules(c, _rules)
|
function rules.matching_rules(c, _rules)
|
||||||
|
@ -165,7 +165,7 @@ end
|
||||||
|
|
||||||
--- Check if a client matches a given set of rules.
|
--- Check if a client matches a given set of rules.
|
||||||
-- @param c The 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.
|
-- "except_any" keys.
|
||||||
-- @return True if at least one rule is matched, false otherwise.
|
-- @return True if at least one rule is matched, false otherwise.
|
||||||
function rules.does_match(c, rules)
|
function rules.does_match(c, rules)
|
||||||
|
|
|
@ -44,7 +44,7 @@ function screen.getbycoord(x, y, default)
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Give the focus to a screen, and move pointer. Keeps relative position of the pointer on the screen.
|
--- 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)
|
function screen.focus(_screen)
|
||||||
client = client or require("awful.client")
|
client = client or require("awful.client")
|
||||||
if _screen > capi.screen.count() then _screen = capi.mouse.screen end
|
if _screen > capi.screen.count() then _screen = capi.mouse.screen end
|
||||||
|
|
|
@ -204,7 +204,7 @@ end
|
||||||
|
|
||||||
--- Create a new wibox and attach it to a screen edge.
|
--- Create a new wibox and attach it to a screen edge.
|
||||||
-- @see wibox
|
-- @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 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 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.
|
-- You can also set the screen key with a screen number to attach the wibox.
|
||||||
|
|
|
@ -209,7 +209,6 @@ function graph:set_height(height)
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Set the graph width.
|
--- Set the graph width.
|
||||||
-- @param graph The graph.
|
|
||||||
-- @param width The width to set.
|
-- @param width The width to set.
|
||||||
function graph:set_width(width)
|
function graph:set_width(width)
|
||||||
if width >= 5 then
|
if width >= 5 then
|
||||||
|
|
|
@ -194,7 +194,6 @@ end
|
||||||
|
|
||||||
--- Parse a directory with .desktop files
|
--- Parse a directory with .desktop files
|
||||||
-- @param dir The directory.
|
-- @param dir The directory.
|
||||||
-- @param icons_size, The icons sizes, optional.
|
|
||||||
-- @return A table with all .desktop entries.
|
-- @return A table with all .desktop entries.
|
||||||
function utils.parse_dir(dir)
|
function utils.parse_dir(dir)
|
||||||
local programs = {}
|
local programs = {}
|
||||||
|
|
|
@ -61,11 +61,12 @@ naughty.config.notify_callback = nil
|
||||||
-- @field low The preset for notifications with low urgency level
|
-- @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 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
|
-- @field critical The preset for notifications with a critical urgency level
|
||||||
|
-- @table naughty.config.presets
|
||||||
naughty.config.presets = {
|
naughty.config.presets = {
|
||||||
normal = {},
|
|
||||||
low = {
|
low = {
|
||||||
timeout = 5
|
timeout = 5
|
||||||
},
|
},
|
||||||
|
normal = {},
|
||||||
critical = {
|
critical = {
|
||||||
bg = "#ff0000",
|
bg = "#ff0000",
|
||||||
fg = "#ffffff",
|
fg = "#ffffff",
|
||||||
|
@ -120,6 +121,7 @@ local suspended = false
|
||||||
-- @field width Popup width
|
-- @field width Popup width
|
||||||
-- @field die Function to be executed on timeout
|
-- @field die Function to be executed on timeout
|
||||||
-- @field id Unique notification id based on a counter
|
-- @field id Unique notification id based on a counter
|
||||||
|
-- @table naughty.notifications
|
||||||
naughty.notifications = { suspended = { } }
|
naughty.notifications = { suspended = { } }
|
||||||
for s = 1, capi.screen.count() do
|
for s = 1, capi.screen.count() do
|
||||||
naughty.notifications[s] = {
|
naughty.notifications[s] = {
|
||||||
|
|
|
@ -124,7 +124,6 @@ function drawable:set_widget(widget)
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Set the background of the drawable
|
--- 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,
|
-- @param c The background to use. This must either be a cairo pattern object,
|
||||||
-- nil or a string that gears.color() understands.
|
-- nil or a string that gears.color() understands.
|
||||||
function drawable:set_bg(c)
|
function drawable:set_bg(c)
|
||||||
|
@ -155,7 +154,6 @@ function drawable:set_bg(c)
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Set the foreground of the drawable
|
--- 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,
|
-- @param c The foreground to use. This must either be a cairo pattern object,
|
||||||
-- nil or a string that gears.color() understands.
|
-- nil or a string that gears.color() understands.
|
||||||
function drawable:set_fg(c)
|
function drawable:set_fg(c)
|
||||||
|
|
Loading…
Reference in New Issue