awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc(progressbar): sanitize paddings/margins (#3556)

This commit is contained in:
Actionless Loveless 2022-02-03 13:25:05 +01:00 committed by GitHub
parent a1f58ab97c
commit 2d6244f944
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
lib/wibox/widget/progressbar.lua
View File

@ -251,7 +251,7 @@ local progressbar = { mt = {} }
-- @propemits false false -- @propemits false false
-- @propbeautiful -- @propbeautiful
-- @see clip -- @see clip
-- @see padding -- @see paddings
-- @see wibox.container.margin -- @see wibox.container.margin
--- The progressbar padding. --- The progressbar padding.
@ -269,10 +269,10 @@ local progressbar = { mt = {} }
-- --
-- @property paddings -- @property paddings
-- @tparam[opt=0] (table|number|nil) padding A table for each side or a number -- @tparam[opt=0] (table|number|nil) padding A table for each side or a number
-- @tparam[opt=0] number padding.top -- @tparam[opt=0] number paddings.top
-- @tparam[opt=0] number padding.bottom -- @tparam[opt=0] number paddings.bottom
-- @tparam[opt=0] number padding.left -- @tparam[opt=0] number paddings.left
-- @tparam[opt=0] number padding.right -- @tparam[opt=0] number paddings.right
-- @propemits false false -- @propemits false false
-- @propbeautiful -- @propbeautiful
-- @see clip -- @see clip
@ -282,25 +282,29 @@ local progressbar = { mt = {} }
-- --
-- Note that if the `clip` is disabled, this allows the background to be smaller -- Note that if the `clip` is disabled, this allows the background to be smaller
-- than the bar. -- than the bar.
-- @beautiful beautiful.progressbar_margins
-- @tparam[opt=0] (table|number|nil) margins A table for each side or a number -- @tparam[opt=0] (table|number|nil) margins A table for each side or a number
-- @tparam[opt=0] number margins.top -- @tparam[opt=0] number margins.top
-- @tparam[opt=0] number margins.bottom -- @tparam[opt=0] number margins.bottom
-- @tparam[opt=0] number margins.left -- @tparam[opt=0] number margins.left
-- @tparam[opt=0] number margins.right -- @tparam[opt=0] number margins.right
-- @beautiful beautiful.progressbar_margins
-- @see clip -- @see clip
-- @see beautiful.progressbar_paddings
-- @see wibox.container.margin
--- The progressbar padding. --- The progressbar padding.
-- --
-- Note that if the `clip` is disabled, this allows the bar to be taller -- Note that if the `clip` is disabled, this allows the bar to be taller
-- than the background. -- than the background.
-- @tparam[opt=0] (table|number|nil) padding A table for each side or a number
-- @tparam[opt=0] number padding.top
-- @tparam[opt=0] number padding.bottom
-- @tparam[opt=0] number padding.left
-- @tparam[opt=0] number padding.right
-- @beautiful beautiful.progressbar_paddings -- @beautiful beautiful.progressbar_paddings
-- @tparam[opt=0] (table|number|nil) padding A table for each side or a number
-- @tparam[opt=0] number paddings.top
-- @tparam[opt=0] number paddings.bottom
-- @tparam[opt=0] number paddings.left
-- @tparam[opt=0] number paddings.right
-- @see clip -- @see clip
-- @see beautiful.progressbar_margins
local properties = { "border_color", "color" , "background_color", local properties = { "border_color", "color" , "background_color",
"value" , "max_value" , "ticks", "value" , "max_value" , "ticks",