wibox.widget.separator: Update the property documentation.

This commit is contained in:
Emmanuel Lepage Vallee 2022-08-21 23:02:27 -07:00
parent f9f04866b8
commit 79496e9acc
1 changed files with 20 additions and 16 deletions

View File

@ -31,12 +31,6 @@ local separator = {}
--- The separator's orientation.
--
-- Valid values are:
--
-- * *vertical*: From top to bottom
-- * *horizontal*: From left to right
-- * *auto*: Decide depending on the widget geometry (default)
--
-- The default value is selected automatically. If the widget is taller than
-- large, it will use vertical and vice versa.
--
@ -44,6 +38,9 @@ local separator = {}
--
-- @property orientation
-- @tparam[opt="auto"] string orientation
-- @propertyvalue "vertical" From top to bottom.
-- @propertyvalue "horizontal" From left to right.
-- @propertyvalue "auto" Decide depending on the widget geometry.
-- @propemits true false
--- The separator's thickness.
@ -51,7 +48,9 @@ local separator = {}
-- This is used by the default line separator, but ignored when a shape is used.
--
-- @property thickness
-- @tparam number thickness
-- @tparam number|nil thickness
-- @propertyunit pixel
-- @negativeallowed false
-- @propbeautiful
-- @propemits true false
@ -60,7 +59,7 @@ local separator = {}
--@DOC_wibox_widget_separator_shape_EXAMPLE@
--
-- @property shape
-- @tparam function shape A valid shape function
-- @tparam shape|nil shape A valid shape function
-- @propbeautiful
-- @propemits true false
-- @see gears.shape
@ -68,13 +67,16 @@ local separator = {}
--- The relative percentage covered by the bar.
--
-- @property span_ratio
-- @tparam[opt=1] number span_ratio A number between 0 and 1.
-- @tparam[opt=1] number|nil span_ratio
-- @rangestart 0.0
-- @rangestop 1.0
-- @propertyunit A gradient between "small" (0.0) and "full width/height" (1.0).
-- @propbeautiful
-- @propemits true false
--- The separator's color.
-- @property color
-- @tparam color color
-- @tparam color|nil color
-- @propbeautiful
-- @propemits true false
-- @see gears.color
@ -84,20 +86,22 @@ local separator = {}
--@DOC_wibox_widget_separator_border_color_EXAMPLE@
--
-- @property border_color
-- @tparam color border_color
-- @tparam color|nil border_color
-- @propbeautiful
-- @propemits true false
-- @see gears.color
--- The separator's border width.
-- @property border_width
-- @tparam number border_width
-- @tparam number|nil border_width
-- @propertyunit pixel
-- @negativeallowed false
-- @propbeautiful
-- @propemits true false
--- The separator thickness.
-- @beautiful beautiful.separator_thickness
-- @param number
-- @tparam[opt=1] number separator_thickness
-- @see thickness
--- The separator border color.
@ -107,7 +111,7 @@ local separator = {}
--- The separator border width.
-- @beautiful beautiful.separator_border_width
-- @param number
-- @tparam[opt=0] number separator_border_width
-- @see border_width
--- The relative percentage covered by the bar.
@ -116,13 +120,13 @@ local separator = {}
--- The separator's color.
-- @beautiful beautiful.separator_color
-- @param string
-- @param color
-- @see gears.color
--- The separator's shape.
--
-- @beautiful beautiful.separator_shape
-- @tparam function shape A valid shape function
-- @tparam[opt=gears.shape.rectangle] shape shape A valid shape function
-- @see gears.shape
local function draw_shape(self, _, cr, width, height, shape)