doc: Upgrade the wibar documentation to the new standards.
This commit is contained in:
parent
6e4eb134b0
commit
0393c93f42
|
@ -36,14 +36,8 @@ local wiboxes = setmetatable({}, {__mode = "v"})
|
||||||
--- If the wibar needs to be stretched to fill the screen.
|
--- If the wibar needs to be stretched to fill the screen.
|
||||||
-- @property stretch
|
-- @property stretch
|
||||||
-- @tparam boolean stretch
|
-- @tparam boolean stretch
|
||||||
|
-- @propbeautiful
|
||||||
--- The wibar's width.
|
-- @propemits true false
|
||||||
-- @property width
|
|
||||||
-- @tparam integer width
|
|
||||||
|
|
||||||
--- The wibar's height.
|
|
||||||
-- @property height
|
|
||||||
-- @tparam integer height
|
|
||||||
|
|
||||||
--- If the wibar needs to be stretched to fill the screen.
|
--- If the wibar needs to be stretched to fill the screen.
|
||||||
-- @beautiful beautiful.wibar_stretch
|
-- @beautiful beautiful.wibar_stretch
|
||||||
|
@ -165,8 +159,17 @@ local function reattach(wb)
|
||||||
end
|
end
|
||||||
|
|
||||||
--- The wibox position.
|
--- The wibox position.
|
||||||
|
--
|
||||||
|
-- The valid values are:
|
||||||
|
--
|
||||||
|
-- * left
|
||||||
|
-- * right
|
||||||
|
-- * top
|
||||||
|
-- * bottom
|
||||||
|
--
|
||||||
-- @property position
|
-- @property position
|
||||||
-- @param string Either "left", right", "top" or "bottom"
|
-- @tparam string position Either "left", right", "top" or "bottom"
|
||||||
|
-- @propemits true false
|
||||||
|
|
||||||
local function get_position(wb)
|
local function get_position(wb)
|
||||||
return wb._position or "top"
|
return wb._position or "top"
|
||||||
|
@ -215,6 +218,8 @@ local function set_position(wb, position, skip_reattach)
|
||||||
-- or right wibars. To solve, this, they need to be re-attached.
|
-- or right wibars. To solve, this, they need to be re-attached.
|
||||||
reattach(wb)
|
reattach(wb)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
wb:emit_signal("property::position", position)
|
||||||
end
|
end
|
||||||
|
|
||||||
local function get_stretch(w)
|
local function get_stretch(w)
|
||||||
|
@ -225,6 +230,8 @@ local function set_stretch(w, value)
|
||||||
w._stretch = value
|
w._stretch = value
|
||||||
|
|
||||||
attach(w, w.position)
|
attach(w, w.position)
|
||||||
|
|
||||||
|
w:emit_signal("property::stretch", value)
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Remove a wibar.
|
--- Remove a wibar.
|
||||||
|
@ -444,6 +451,8 @@ end
|
||||||
|
|
||||||
--@DOC_wibox_COMMON@
|
--@DOC_wibox_COMMON@
|
||||||
|
|
||||||
|
--@DOC_object_COMMON@
|
||||||
|
|
||||||
return setmetatable(awfulwibar, awfulwibar.mt)
|
return setmetatable(awfulwibar, awfulwibar.mt)
|
||||||
|
|
||||||
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|
||||||
|
|
Loading…
Reference in New Issue