wibox.container.scroll: Add a usage example

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-02-25 16:51:03 +01:00 · 2017-02-25 16:51:03 +01:00 · 6fb40a196f
parent 3d12ba3b65
commit 6fb40a196f
1 changed files with 12 additions and 0 deletions
--- a/lib/wibox/container/scroll.lua
+++ b/lib/wibox/container/scroll.lua
@ -1,4 +1,16 @@
 ---------------------------------------------------------------------------
+-- @usage
+-- wibox.widget {
+--    layout = wibox.container.scroll.horizontal,
+--    max_size = 100,
+--    step_function = wibox.container.scroll.step_functions
+--                    .waiting_nonlinear_back_and_forth,
+--    speed = 100,
+--    {
+--        widget = wibox.widget.textbox,
+--        text = "This is a " .. string.rep("very, ", 10) ..  " very long text",
+--    },
+-- }
 -- @author Uli Schlachter (based on ideas from Saleur Geoffrey)
 -- @copyright 2015 Uli Schlachter
 -- @classmod wibox.container.scroll