diff --git a/docs/common/cursor.ldoc b/docs/common/cursor.ldoc new file mode 100644 index 000000000..8401b2e45 --- /dev/null +++ b/docs/common/cursor.ldoc @@ -0,0 +1,80 @@ +
+--
num\_glyphs
+--
arrow
+--
based\_arrow\_down
+--
based\_arrow\_up
+--
boat
+--
bogosity
+--
bottom\_left\_corner
+--
bottom\_right\_corner
+--
bottom\_side
+--
bottom\_tee
+--
box\_spiral
+--
center\_ptr
+--
circle
+--
clock
+--
coffee\_mug
+--
cross
+--
crosshair
+--
cross\_reverse
+--
cursor
+--
diamond\_cross
+--
dotbox
+--
dot
+--
double\_arrow
+--
draft\_large
+--
draft\_small
+--
draped\_box
+--
exchange
+--
fleur
+--
gobbler
+--
gumby
+--
hand
+--
hand
+--
heart
+--
icon
+--
iron\_cross
+--
leftbutton
+--
left\_ptr
+--
left\_side
+--
left\_tee
+--
ll\_angle
+--
lr\_angle
+--
man
+--
middlebutton
+--
mouse
+--
pencil
+--
pirate
+--
plus
+--
question\_arrow
+--
rightbutton
+--
right\_ptr
+--
right\_side
+--
right\_tee
+--
rtl\_logo
+--
sailboat
+--
sb\_down\_arrow
+--
sb\_h\_double\_arrow
+--
sb\_left\_arrow
+--
sb\_right\_arrow
+--
sb\_up\_arrow
+--
sb\_v\_double\_arrow
+--
shuttle
+--
sizing
+--
spider
+--
spraycan
+--
star
+--
target
+--
tcross
+--
top\_left\_arrow
+--
top\_left\_corner
+--
top\_right\_corner
+--
top\_side
+--
top\_tee
+--
trek
+--
ul\_angle
+--
umbrella
+--
ur\_angle
+--
watch
+--
xterm
+--
diff --git a/lib/gears/timer.lua b/lib/gears/timer.lua index 5606b87a4..28045292d 100644 --- a/lib/gears/timer.lua +++ b/lib/gears/timer.lua @@ -145,7 +145,7 @@ end -- @see start -- @see stop ---- The timer timeout value. +--- The timer timeout value in seconds. -- -- @property timeout -- @tparam[opt=0] number timeout @@ -182,8 +182,8 @@ local timer_instance_mt = { -- -- @tparam table args Arguments. -- @tparam number args.timeout Timeout in seconds (e.g. `1.5`). --- @tparam[opt=false] boolean args.autostart Automatically start the timer. --- @tparam[opt=false] boolean args.call_now Call the callback at timer creation. +-- @tparam[opt=false] boolean args.autostart Immediately start the timer countdown. +-- @tparam[opt=false] boolean args.call_now Immediately call the callback function. -- @tparam[opt] function args.callback Callback function to connect to the -- "timeout" signal. -- @tparam[opt=false] boolean args.single_shot Run only once then stop. diff --git a/lib/wibox/widget/graph.lua b/lib/wibox/widget/graph.lua index 96fa3d2e5..9982dbbd5 100644 --- a/lib/wibox/widget/graph.lua +++ b/lib/wibox/widget/graph.lua @@ -1,9 +1,9 @@ --------------------------------------------------------------------------- --- Display multiple values as a stream of bars. -- --- The graph goes from left to right. To change this to right to left, use --- a `wibox.container.mirror` widget. This can also be used to have data --- shown from top to bottom. +-- The graph goes from left to right. To change the movement's direction, +-- use a `wibox.container.mirror` widget. This can also be used to have +-- data shown from top to bottom. -- -- To add text on top of the graph, use a `wibox.layout.stack` and a -- `wibox.container.align` widgets. diff --git a/lib/wibox/widget/separator.lua b/lib/wibox/widget/separator.lua index 3d13cb881..32f44e5ae 100644 --- a/lib/wibox/widget/separator.lua +++ b/lib/wibox/widget/separator.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- -- A flexible separator widget. -- --- By default, this widget display a simple line, but can be extended by themes +-- By default, this widget displays a simple line, but can be extended by themes -- (or directly) to display much more complex visuals. -- -- This widget is mainly intended to be used alongside the `spacing_widget` diff --git a/lib/wibox/widget/slider.lua b/lib/wibox/widget/slider.lua index 690ee7fad..dedc45415 100644 --- a/lib/wibox/widget/slider.lua +++ b/lib/wibox/widget/slider.lua @@ -89,7 +89,11 @@ local slider = {mt={}} -- @propemits true false -- @propbeautiful ---- The handle grab cursor. +--- The cursor icon while grabbing the handle. +-- The available cursor names are: +-- +--@DOC_cursor_COMMON@ +-- -- @property handle_cursor -- @tparam[opt="fleur"] string|nil handle_cursor -- @propbeautiful @@ -228,7 +232,10 @@ local slider = {mt={}} -- @tparam[opt=gears.shape.rectangle] gears.shape shape -- @see gears.shape ---- The handle grab cursor. +--- The cursor icon while grabbing the handle. +-- The available cursor names are: +-- +--@DOC_cursor_COMMON@ -- -- @beautiful beautiful.slider_handle_cursor -- @tparam[opt="fleur"] string cursor @@ -565,7 +572,9 @@ end -- @tparam[opt] number args.handle_width The slider handle width. -- @tparam[opt] color args.handle_border_color The handle border_color. -- @tparam[opt] number args.handle_border_width The handle border width. --- @tparam[opt] string args.handle_cursor The handle grab cursor. +-- @tparam[opt] string args.handle_cursor +-- The cursor icon while grabbing the handle. +-- The available cursor names are listed under handle_cursor, in the "Object properties" section. -- @tparam[opt] gears.shape args.bar_shape The bar (background) shape. -- @tparam[opt] number args.bar_height The bar (background) height. -- @tparam[opt] color args.bar_color The bar (background) color.