docs.common.wibox.ldoc: Update the property documentation.

This commit is contained in:
Emmanuel Lepage Vallee 2022-08-21 23:02:26 -07:00
parent 50c98059b8
commit 0cf97e007d
1 changed files with 35 additions and 14 deletions

View File

@ -3,6 +3,8 @@
-- @baseclass wibox
-- @property border_width
-- @tparam[opt=0] integer border_width
-- @propertyunit pixel
-- @negativeallowed false
-- @propemits false false
--- Border color.
@ -39,7 +41,8 @@
--
-- @baseclass wibox
-- @property cursor
-- @tparam string cursor
-- @tparam[opt=nil] string|nil cursor
-- @propertytype nil Do not change the mouse cursor.
-- @see mouse
-- @propemits false false
@ -47,21 +50,23 @@
--
-- @baseclass wibox
-- @property visible
-- @tparam boolean visible
-- @tparam[opt=false] boolean visible
-- @propemits false false
--- The opacity of the wibox, between 0 and 1.
--
-- @baseclass wibox
-- @property opacity
-- @tparam number opacity (between 0 and 1)
-- @tparam[opt=true] number opacity
-- @rangestart 0.0
-- @rangestop 1.0
-- @propemits false false
--- The window type (desktop, normal, dock, ...).
--
-- @baseclass wibox
-- @property type
-- @tparam string type
-- @tparam[opt=""] string type
-- @see client.type
-- @propemits false false
@ -69,28 +74,38 @@
--
-- @baseclass wibox
-- @property x
-- @tparam integer x
-- @tparam[opt=0] integer x
-- @propertyunit pixel
-- @negativeallowed true
-- @propemits false false
--- The y coordinates.
--
-- @baseclass wibox
-- @property y
-- @tparam integer y
-- @tparam[opt=0] integer y
-- @propertyunit pixel
-- @negativeallowed true
-- @propemits false false
--- The width of the wibox.
--
-- @baseclass wibox
-- @property width
-- @tparam integer width
-- @tparam[opt=1] integer width
-- @propertyunit pixel
-- @rangestart 1
-- @negativeallowed false
-- @propemits false false
--- The height of the wibox.
--
-- @baseclass wibox
-- @property height
-- @tparam integer height
-- @tparam[opt=1] integer height
-- @propertyunit pixel
-- @rangestart 1
-- @negativeallowed false
-- @propemits false false
--- The wibox screen.
@ -98,9 +113,10 @@
-- @baseclass wibox
-- @property screen
-- @tparam screen screen
-- @propertydefault The screen which contains `0x0`.
-- @propemits true false
--- The wibox's `drawable`.
-- The wibox's `drawable`.
--
-- @baseclass wibox
-- @property drawable
@ -110,7 +126,7 @@
--- The widget that the `wibox` displays.
-- @baseclass wibox
-- @property widget
-- @tparam[opt=nil] wibox.widget widget
-- @tparam[opt=nil] widget|nil widget
-- @propemits true false
--- The X window id.
@ -118,6 +134,7 @@
-- @baseclass wibox
-- @property window
-- @tparam string window
-- @propertydefault Autogenerated.
-- @see client.window
-- @propemits false false
@ -130,6 +147,7 @@
-- @baseclass wibox
-- @property shape_bounding
-- @tparam surface._native shape_bounding
-- @propertydefault Fill all pixels.
-- @propemits false false
-- @see shape
@ -141,6 +159,7 @@
-- @baseclass wibox
-- @property shape_clip
-- @tparam surface._native shape_clip
-- @propertydefault Fill all pixels.
-- @propemits false false
-- @see shape
@ -153,6 +172,7 @@
-- @baseclass wibox
-- @property shape_input
-- @tparam surface._native shape_input
-- @propertydefault Fill all pixels.
-- @propemits false false
-- @see input_passthrough
@ -160,7 +180,7 @@
--
-- @baseclass wibox
-- @property shape
-- @tparam gears.shape shape
-- @tparam[opt=gears.shape.rectangle] shape shape
-- @propemits true false
-- @see gears.shape
@ -182,7 +202,8 @@
--
-- @baseclass wibox
-- @property buttons
-- @tparam table buttons A table of buttons objects, or nothing.
-- @tparam[opt={}] table buttons A table of buttons objects, or nothing.
-- @tablerowtype A list of `awful.button`s.
-- @propemits false false
--- Get or set wibox geometry. That's the same as accessing or setting the x,
@ -242,7 +263,7 @@
--
-- @baseclass wibox
-- @property bgimage
-- @tparam gears.suface|string|function bgimage A background image or a function.
-- @tparam[opt=nil] image|nil bgimage
-- @see gears.surface
-- @propemits true false
@ -250,7 +271,7 @@
--
-- @baseclass wibox
-- @property fg
-- @tparam[opt=beautiful.fg_normal] gears.color fg
-- @tparam[opt=beautiful.fg_normal] color fg
-- @see gears.color
-- @propemits true false
-- @usebeautiful beautiful.fg_normal The default (fallback) fg color.