Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc(w.l.fixed): Improve documentation for spacing properties 

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
This commit is contained in:
Lucas Schwiderski 2021-07-13 22:45:15 +02:00
parent f2c66b006d
commit 4b30158176
No known key found for this signature in database
GPG Key ID: AA12679AAA6DF4D8
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/wibox/layout/fixed.lua
View File

@ -285,9 +285,13 @@ function fixed:set(index, widget2)
return true return true
end end
--- The widget used to fill the spacing between the layout elements. --- A widget to insert as a separator between child widgets.
-- --
-- By default, no widget is used. -- If this property is a valid widget and `spacing` is greater than `0`, a
-- copy of this widget is inserted between each child widget, with its size in
-- the layout's main direction determined by `spacing`.
--
-- By default no widget is used and any `spacing` is applied as an empty offset.
-- --
--@DOC_wibox_layout_fixed_spacing_widget_EXAMPLE@ --@DOC_wibox_layout_fixed_spacing_widget_EXAMPLE@
-- --
@ -441,7 +445,9 @@ function fixed.vertical(...)
return get_layout("y", ...) return get_layout("y", ...)
end end
--- Add spacing between each layout widgets. --- The amount of space inserted between the child widgets.
--
-- If a `spacing_widget` is defined, this value is used for its size.
-- --
--@DOC_wibox_layout_fixed_spacing_EXAMPLE@ --@DOC_wibox_layout_fixed_spacing_EXAMPLE@
-- --